Struct ScanResult 

pub struct ScanResult {
    pub findings: Vec<CredentialFinding>,
}

The result of a CredentialScanner::scan call.

Fields

findings: Vec<CredentialFinding>

All credential findings detected in the scanned text, sorted by byte offset.

Implementations

impl ScanResult

pub fn is_clean(&self) -> bool

Returns true if no credential findings were detected.

pub fn redact(&self, text: &str) -> String

Returns a copy of text with every finding replaced by its redacted label.

Replacements are applied in reverse offset order so earlier byte positions remain valid after each splice. The end field of each finding records the original match boundary and is used here without being exposed in the public API.

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 Eq for ScanResult

impl PartialEq for ScanResult

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