Skip to main content

Module scanned_excerpt_source

Module scanned_excerpt_source 

Source
Expand description

OM.A1 — the registry of agenda-row producers.

The agenda twin of media_source, and the same contract: an async, off-keystroke-path producer the host drives on a trigger. Where a media source answers “what images does this buffer show”, an agenda source answers “what dated rows does this FILE contribute” — once per file of a project walk.

Nothing here names org. A source declares the extensions it wants offered (ScannedExcerptSource::extensions) and the host offers it only those files, which is what keeps .org out of the host walk.

Structs§

ClockSpan
Time clocked on one headline on one day (OA.14b).
RowAnnotation
One line hung below a row, and how it is coloured (HB.5).
RowSpan
One styled run within a row, naming a style rather than carrying one.
ScanResult
What one file’s scan produced.
ScannedExcerpt
One agenda row a producer found in a file.
ScannedExcerptSourceRegistry
Runtime-mutable registry of ScannedExcerptSources.

Traits§

ScannedExcerptSource
An async, off-keystroke-path producer of agenda rows.

Type Aliases§

ScanBeginFuture
The boxed future an ScannedExcerptSource::begin returns.
ScanDescribeFuture
The future ScannedExcerptSource::describe returns (OA.22).
ScanFuture
The boxed future an ScannedExcerptSource::scan returns.
ScanRootsFuture
The boxed future an ScannedExcerptSource::roots returns (AF.1).
ScannedExcerptSourceRegistryHandle
Boot-service handle. Register and look up with this exact alias (the ServiceRegistry TypeId rule).