Struct FileReport 

#[non_exhaustive]
pub struct FileReport {
    pub path: String,
    pub matches: u64,
    pub replacements: u64,
    pub bytes_processed: u64,
    pub bytes_output: u64,
    pub pattern_counts: HashMap<String, u64>,
    pub method: String,
    pub log_context: Option<LogContextResult>,
    pub match_locations: Option<MatchLocationsResult>,
}

Per-file result details.

Does not contain any original secret values — only counts, byte sizes, pattern labels, and the processing method used.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

path: String

File path (relative or archive entry name).

matches: u64

Number of matches found in this file.

replacements: u64

Number of replacements applied.

bytes_processed: u64

Bytes read from this file.

bytes_output: u64

Bytes written for this file.

pattern_counts: HashMap<String, u64>

Per-pattern match counts for this file.

method: String

Processing method: "scanner", "structured:json", etc.

log_context: Option<LogContextResult>

Log context extraction results for this file, present when --extract-context was used.

match_locations: Option<MatchLocationsResult>

Per-match line numbers and byte offsets, present when --max-match-locations is non-zero and the scanner path is used. Structured-processor paths do not populate this field.

Implementations

impl FileReport

pub fn new(path: impl Into<String>, method: impl Into<String>) -> Self

Create an empty report (all counters zero) for path with the given processing method. Use when a file was routed but produced no scan stats. The struct is #[non_exhaustive], so this or from_scan_stats is how it is built outside the crate.

pub fn from_scan_stats( path: impl Into<String>, stats: &ScanStats, method: impl Into<String>, ) -> Self

Build a FileReport from scanner ScanStats.

pub fn with_match_locations( self, locations: Vec<MatchLocation>, truncated: bool, ) -> Self

Attach per-match location data collected via crate::scanner::StreamScanner::scan_reader_with_callbacks.

No-ops when locations is empty and truncated is false, keeping the JSON output clean for files with no scanner matches.

Trait Implementations

impl Clone for FileReport

fn clone(&self) -> FileReport

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileReport

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

Formats the value using the given formatter.

impl Serialize for FileReport

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.