Struct Finding 

pub struct Finding {
    pub rule_id: String,
    pub category: Category,
    pub severity: Severity,
    pub start: usize,
    pub end: usize,
    pub normalized_only: bool,
}

One match of one rule.

The matched text is deliberately not stored: reports are often logged, and logging the very secret or personal data that was detected defeats the purpose. Use Finding::excerpt when you really need it.

Fields

rule_id: String

Id of the rule that matched.

category: Category

Category of the rule.

severity: Severity

Severity of the rule.

start: usize

Byte offset in the original text where the match starts.

end: usize

Byte offset in the original text where the match ends (exclusive).

normalized_only: bool

true if the rule matched only after normalization (for example the input used full-width letters or zero-width characters). This is a strong signal of deliberate evasion.

Implementations

impl Finding

pub fn excerpt<'a>(&self, original: &'a str) -> &'a str

The matched slice of original, which must be the text that was scanned.

Panics

Panics if the offsets are out of range or not on char boundaries, i.e. if original is not the scanned text.

Trait Implementations

impl Clone for Finding

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 Finding

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Finding

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Finding

impl PartialEq for Finding

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Finding

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Finding