Struct ScanViewState 

pub struct ScanViewState {
    pub provider: String,
    pub options: ScanViewOptions,
    pub clock: Vec<ClockSpan>,
    pub annotations: Vec<RowAnnotationAt>,
    pub annotations_version: u64,
}

Per-view scan state. OM.A3’s gr reads the root back out of this so a refresh re-scans what the view already shows rather than resetting to the current working directory.

Fields

provider: String

The provider name this view was opened under.

gr re-opens the view by name, and the name is the VIEW’s, not this module’s: a scan view declared by a plugin is called whatever that plugin called it. Before this the refresh handler re-emitted a hardcoded "agenda", so a refresh in any other scan view would have gone to org’s — which is the sort of thing a generic mode with an org-shaped constant in it does.

options: ScanViewOptions

clock: Vec<ClockSpan>

OA.14b: every clocked span the last completed scan saw, across every file and source, unfiltered by date.

Held per view rather than recomputed because the report’s RANGE is a display choice — gD switches between day, week, month and year — and re-walking the corpus to answer a question the data already contains would make a toggle cost a scan. org-agenda-clockreport-mode (OA.16) filters on day and rolls the totals up each span’s outline path.

Written once at the end of a scan, not incrementally: a half-filled report is a wrong report, and unlike rows — which stream so the view fills in — nobody is reading a total until it is a total.

annotations: Vec<RowAnnotationAt>

HB.5: the rows a scan asked to hang below its own, already translated into COMPOSED coordinates.

Translated at publish rather than at paint, for composed_row_spans’ reason: a row’s composed index is not its index among its own file’s rows — the sort interleaves files — and the arithmetic belongs where the excerpt layout is in hand, not in a provider that would have to reconstruct it.

annotations_version: u64

Bumped whenever annotations is written, so the cells worker re-runs the provider’s collect without waiting for the document’s line count to move. A refresh that returns the same NUMBER of rows with different annotations is the case this exists for.

Trait Implementations

impl Clone for ScanViewState

fn clone(&self) -> ScanViewState

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ScanViewState

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.