Struct ScanResult 

pub struct ScanResult {
    pub matches: Vec<Match>,
    pub truncated: bool,
    pub elapsed: Duration,
    pub cache_hit: bool,
}

Diagnostic-bearing wrapper around a scan result.

Every consumer pipeline ends up reconstructing these flags ad-hoc (was the scan truncated? how long did it take? did we hit the disk cache?). Centralising them gives downstream tooling (telemetry pipelines, watch-mode dashboards, perf benches) a single struct to read instead of parsing engine-specific output.

ScanResult::matches is the primary payload - consumers that don’t care about diagnostics can result.matches and ignore the rest. The struct is Clone so it can be passed across thread boundaries and Default so tests can fabricate empties.

Fields

matches: Vec<Match>

Sorted matches produced by the engine.

truncated: bool

True when the engine hit the per-dispatch max_matches cap AND the underlying scan reported overflow. Consumers should treat truncated results as incomplete and re-scan with a larger cap if every match matters (security audits).

elapsed: Duration

Total wall-clock time the scan call spent, including dispatch

• readback. Duration::ZERO when the engine doesn’t measure.

cache_hit: bool

True when the engine was loaded from disk cache instead of being recompiled. Used by perf tooling to attribute cold- start cost.

Implementations

impl ScanResult

pub fn from_matches(matches: Vec<Match>) -> Self

Build a result from a bare match vector. Diagnostic flags default to safe values (not truncated, zero elapsed, no cache hit). For engines that produce richer diagnostics, construct the struct directly.

pub fn len(&self) -> usize

Number of matches produced.

pub fn is_empty(&self) -> bool

True when the engine produced no matches.

Trait Implementations

impl Clone for ScanResult

fn clone(&self) -> ScanResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScanResult

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

Formats the value using the given formatter.

impl Default for ScanResult

fn default() -> ScanResult

Returns the “default value” for a type.