Struct Finding 

pub struct Finding {
    pub rule_id: String,
    pub span: (usize, usize),
    pub snippet: String,
    pub snippet_truncated: bool,
    pub container: Container,
    pub topic_term: bool,
}

One detected pattern occurrence, cited by byte span into the input text.

Fields

rule_id: String

Stable rule identifier from the pattern data.

span: (usize, usize)

Byte span (start, end) of the full match in the input text. The span always covers the whole occurrence, even when the snippet is capped.

snippet: String

The matched text, verbatim from the input. Equal to the source slice at span when that slice is at most 200 bytes. Otherwise the first 200 bytes of it (cut on a character boundary) with snippet_truncated set.

snippet_truncated: bool

True when the snippet is a capped prefix of the source slice at span.

container: Container

Container classification of the span’s start position. Annotation only: a fenced or quoted finding still reports.

topic_term: bool

True when the matched text equals one of the caller-supplied topic-vocabulary terms (--allow-term, case-insensitive whole-term equality). Labeling only: the flag cannot fire or silence anything.

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 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