Struct ScanCache 

pub struct ScanCache { /* private fields */ }

A persistent agenda-result cache for one source.

Implementations

impl ScanCache

pub fn open(dir: &Path, source_id: u64) -> Self

Open (or start) the cache for source_id under dir.

Never fails: an unreadable, corrupt or stale file yields an empty cache with a debug log. dir is the host’s per-plugin data directory, so two plugins cannot collide and uninstalling one removes its cache.

pub fn begin(&mut self, generation: u64)

Start a scan under generation (the guest’s begin return value).

A changed generation means every cached row was computed against something that no longer holds — for org, a different day or a different keyword set — so the whole cache is dropped rather than partially trusted.

pub fn get( &mut self, path: &str, text: &str, ) -> Option<(Vec<Entry>, Vec<ClockSpan>)>

Cached rows + clock spans for path, if the text still hashes the same.

pub fn put( &mut self, path: &str, text: &str, rows: &[Entry], clock: &[ClockSpan], )

Remember what the guest returned for path.

pub fn flush(&mut self)

Write the cache out. Best-effort: a failure is logged and dropped, because a cache that cannot be written is only a slower next scan.

Written to a temporary file and renamed, so a kill mid-write leaves the previous cache intact rather than a truncated file the next boot has to recognise as corrupt.

Trait Implementations

impl Debug for ScanCache

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

Formats the value using the given formatter.

impl Drop for ScanCache

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.