Struct WasmScannedExcerptSource 

pub struct WasmScannedExcerptSource { /* private fields */ }

An async agenda-row producer over a plugin’s ScanClient.

Implementations

impl WasmScannedExcerptSource

pub fn new( client: ScanClient, extensions: Vec<String>, view_mode: Option<String>, ) -> Self

pub fn with_cache(self, dir: &Path) -> Self

OT.3b: give this source a persistent result cache rooted at dir (the plugin’s own data directory, so two plugins cannot collide and uninstalling one removes its cache).

Opt-in rather than built in new: a caller with no data directory — tests, benches — gets an uncached source that behaves identically, just slower, which is also what makes the cache easy to A/B.

pub fn plugin_id(&self) -> PluginId

Trait Implementations

impl Clone for WasmScannedExcerptSource

fn clone(&self) -> WasmScannedExcerptSource

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WasmScannedExcerptSource

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

Formats the value using the given formatter.

impl ScannedExcerptSource for WasmScannedExcerptSource

fn roots(&self) -> ScanRootsFuture<'_>

AF.1. NOT cached beside extensions / view_mode, and that asymmetry is the point: those are facts about the source, this is a fact about the user’s config. Caching it would make the source’s own setting appear not to work until the editor restarted.

A guest that traps or is quarantined answers empty rather than failing the scan — the same degradation begin gets, one step earlier.

fn describe(&self, args: &[String]) -> ScanDescribeFuture<'_>

OA.22. Degrades to empty on a trap or a quarantined guest, exactly as roots does — a header that could not be built is a missing phrase, not a failed scan.

fn source_id(&self) -> u64

Stable id of the producing plugin — the teardown key. Two producers with the same id are the same plugin, so a reload replaces rather than duplicates.

fn extensions(&self) -> &[String]

File extensions this source wants offered, lowercased and without the leading dot. Resolved once at registration and cached here, so the walk’s per-file test is a string compare rather than a guest call.

fn view_mode(&self) -> Option<&str>

A minor mode this source wants activated on the agenda view.

fn begin(&self, args: &[String]) -> ScanBeginFuture<'_>

Drop per-scan state. Called once before the first file of a scan.

fn scan(&self, path: PathBuf, text: String) -> ScanFuture<'_>

Scan one file. text is the file’s contents, already read by the host — the host must read it anyway to build the source Document, so it reads once and hands the text over.

fn claims(&self, path: &Path) -> bool

True when path’s extension is one this source claimed.