Struct ScanReport 

pub struct ScanReport {
    pub merges_seen: usize,
    pub merges_scanned: usize,
    pub skipped_octopus: usize,
    pub skipped_no_base: usize,
    pub paths_scanned: usize,
    pub skipped_binary: usize,
    pub skipped_large: usize,
    pub lines_relocated: usize,
    pub paths_all_relocated: usize,
    pub lines_surviving_elsewhere: usize,
    pub findings_all_surviving: usize,
    pub findings: Vec<Finding>,
}

What one repository’s scan counted.

Every skip is counted rather than dropped: a rate whose denominator quietly excluded the hard cases is the failure mode this whole measurement exists to avoid.

Fields

merges_seen: usize

Merge commits the log produced.

merges_scanned: usize

Merge commits actually compared.

skipped_octopus: usize

Merges with three or more parents, which this comparison does not model: there is no single proposed side.

skipped_no_base: usize

Merges whose parents share no merge base, or whose objects are missing from a filtered clone.

paths_scanned: usize

Paths compared.

skipped_binary: usize

Paths where some blob was not valid UTF-8.

skipped_large: usize

Paths where some blob exceeded MAX_BLOB_BYTES.

lines_relocated: usize

Distinct lines cancelled as moved between paths within one merge rather than lost. See scan_merge.

paths_all_relocated: usize

Paths whose whole apparent violation was relocation, and which therefore produced no finding.

lines_surviving_elsewhere: usize

Distinct lines reported as reverted that are nonetheless present somewhere in the merge result. Counted, never cancelled: see scan_merge on why this is a second number and not a filter.

findings_all_surviving: usize

Findings every one of whose reverted lines survives somewhere in the result, and which carry no injection either. These are the candidates for refactor noise rather than lost work.

findings: Vec<Finding>

The violations, in the order found.

Implementations

impl ScanReport

pub fn merge_violation_rate(&self) -> f64

Merges carrying at least one finding, over merges scanned.

Returns 0.0 for an empty scan rather than a NaN: “nothing was examined” and “nothing was found” must not print the same way.

pub fn absorb(&mut self, other: Self)

Folds another repository’s report into this one.

Trait Implementations

impl Clone for ScanReport

fn clone(&self) -> ScanReport

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScanReport

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

Formats the value using the given formatter.

impl Default for ScanReport

fn default() -> ScanReport

Returns the “default value” for a type.

impl PartialEq for ScanReport

fn eq(&self, other: &ScanReport) -> 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 Eq for ScanReport

impl StructuralPartialEq for ScanReport