Struct ScanClient 

pub struct ScanClient { /* private fields */ }

The Send + Sync handle a caller holds. Cloning is cheap; every clone talks to the same actor / Store, so calls serialise on the single-consumer loop the !Sync Store requires — which is exactly what begin-then-scan needs.

Implementations

impl ScanClient

pub fn id(&self) -> PluginId

pub async fn extensions(&self) -> Result<Vec<String>, PluginHostError>

Call the guest’s extensions(). Once, at load.

pub async fn view_mode(&self) -> Result<Option<String>, PluginHostError>

Call the guest’s view-mode(). Once, at load.

pub async fn roots(&self) -> Result<Vec<String>, PluginHostError>

AF.1: call the guest’s roots(). Per scan, not once at load — the answer comes from user configuration and must follow a :set.

pub async fn begin(&self, args: Vec<String>) -> Result<u64, PluginHostError>

Call the guest’s begin() — the start of a scan. Returns the guest’s generation key (OT.3b): an opaque u64 that changes when anything scan-wide would change its rows, so the host can invalidate cached results without knowing what those things are.

OA.11a: args are the view’s own scan arguments, forwarded verbatim.

pub async fn describe( &self, args: Vec<String>, ) -> Result<String, PluginHostError>

OA.22: ask the guest what this view IS, for the headerline.

Called once per scan, after Self::begin, so the guest sees the args begin stashed. The host cannot answer this itself: it deliberately does not read args, so a filtered agenda would otherwise look exactly like an unfiltered one.

pub async fn scan( &self, path: String, text: String, ) -> Result<Result<ScanResult, String>, PluginHostError>

Call the guest’s scan(path, text).

The outer result is the host surface (trap / gone / quarantined); the inner Result<_, String> is the guest’s own WIT result. Either way the caller skips THIS FILE and continues — one bad file must not fail the agenda.

Trait Implementations

impl Clone for ScanClient

fn clone(&self) -> ScanClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScanClient

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

Formats the value using the given formatter.