Struct ScanMetrics 

pub struct ScanMetrics {
    pub detections: u32,
    pub redacted: u32,
    pub restored: u32,
    pub blocked: u32,
    pub by_entity_type: BTreeMap<String, u32>,
    pub latency_us: u64,
}

A single scanner’s content-free metrics for one run: counts and per-entity- type tallies plus the scanner’s own latency. Every field is a count, a verdict, or an entity-type label — never matched content, a redacted value, or plaintext — so a ScanReport is safe to log or emit wholesale.

The counts are derived by the ScannerStack run loop, not reported by the scanner itself (the Scanner::scan surface stays a pure text -> Verdict): the loop times each scan and diffs the shared Vault’s type-keyed tallies across the call. A transform scanner’s redacted/by_entity_type is the vault-intern delta; a restore scanner’s restored is the vault restore-tally delta; a block scanner’s detections/ blocked come from its Verdict.

Fields

detections: u32

Matches or entities this scanner found. For a transform scanner this is the number of distinct values redacted; for a block scanner it is 1 on a hit, 0 otherwise.

redacted: u32

Distinct values this scanner transformed/replaced (redactions). 0 for a pure block scanner, which never rewrites.

restored: u32

Sentinels this scanner put back (restore scanners only).

blocked: u32

How many times this scanner blocked: 1 when it returned a [Block] verdict with valid = false, else 0.

by_entity_type: BTreeMap<String, u32>

Per-entity-type redaction counts (EMAIL, AWS_ACCESS_KEY…). Keys are type labels, never values, and the map is empty for a block scanner.

latency_us: u64

Wall-clock time spent in this scanner’s Scanner::scan, in microseconds.

Trait Implementations

impl Clone for ScanMetrics

fn clone(&self) -> ScanMetrics

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScanMetrics

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

Formats the value using the given formatter.

impl Default for ScanMetrics

fn default() -> ScanMetrics

Returns the “default value” for a type.

impl PartialEq for ScanMetrics

fn eq(&self, other: &ScanMetrics) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ScanMetrics