Struct Finding 

pub struct Finding {
    pub id: usize,
    pub secret: String,
    pub detector: String,
    pub len: usize,
    pub field: Option<String>,
    pub path: Option<String>,
    pub offsets: Vec<usize>,
    pub occurrences: usize,
}

One redacted secret. Every occurrence of the same text shares a finding.

Fields

id: usize

1-based id of this distinct value in the document. Same text shares an id. The replacement token is REDACTION-<id>.

secret: String

The redacted text.

detector: String

What detected the first occurrence.

len: usize

Length of the secret in bytes.

field: Option<String>

Field (object key) of the value containing the first occurrence, if any.

path: Option<String>

Key path of the value containing the first occurrence: the keys of the enclosing objects and the field itself, joined with .. None for values that have no key, such as the text of a plain-text file.

offsets: Vec<usize>

Byte offsets of every occurrence in the input, ascending, when the format reports value positions. Approximate for values containing escape sequences.

occurrences: usize

How many times the text was redacted.

Implementations

impl Finding

pub fn token(&self) -> String

The replacement token for this secret.

pub fn offset(&self) -> Option<usize>

Byte offset of the first occurrence, when known.

Trait Implementations

impl Clone for Finding

fn clone(&self) -> Finding

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Finding

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

Formats the value using the given formatter.

impl Eq for Finding

impl PartialEq for Finding

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Finding