Struct ScanStats 

pub struct ScanStats {
    pub lines: u64,
    pub bytes: u64,
    pub lines_skipped: u64,
    pub finder_lines_skipped: u64,
    pub positions: u64,
    pub coarse_positions: u64,
    pub candidate_positions: u64,
    pub run_gated: u64,
    pub coarse_rejected: Vec<u64>,
    pub matches: u64,
    pub sorts: u64,
    pub finders: Vec<FinderStats>,
}

Operation counters collected by Scanner::scan_line_stats.

The counters describe how much work the scanner and its finders did, so that performance can be reasoned about independently of wall-clock time: a finder invocation is the unit of work the scanner dispatches, and the ratio of invocations to hits shows how well candidate filtering works.

Fields

lines: u64

Lines scanned (including empty lines).

bytes: u64

Bytes scanned.

lines_skipped: u64

Lines on which the prescan disabled every finder.

finder_lines_skipped: u64

Finder×line pairs disabled by the prescan.

positions: u64

Positions visited by the dispatch and trigger loops (one per byte and per loop that ran).

coarse_positions: u64

Positions the vector stage passed on to the exact gates (Strategy::Vector only).

candidate_positions: u64

Positions where at least one candidate finder was invoked.

run_gated: u64

Finder invocations avoided by run rules.

coarse_rejected: Vec<u64>

Coarse positions the exact gates rejected, by the byte at the position (diagnostics for the vector stage’s precision).

matches: u64

Matches returned to the caller.

sorts: u64

Lines whose matches had to be sorted.

finders: Vec<FinderStats>

One entry per finder, in scanner order.

Implementations

impl ScanStats

pub fn for_scanner(scanner: &Scanner) -> Self

Creates counters sized for scanner.

pub fn merge(&mut self, other: &ScanStats)

Adds other into self; both must come from scanners with the same finder list.

pub fn calls(&self) -> u64

Total finder invocations of any mode.

pub fn hits(&self) -> u64

Total finder invocations that returned Some.

Trait Implementations

impl Clone for ScanStats

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScanStats

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

Formats the value using the given formatter.

impl Default for ScanStats

fn default() -> Self

Returns the “default value” for a type.

impl Eq for ScanStats

impl PartialEq for ScanStats

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ScanStats