Skip to main content

Finding

Struct Finding 

Source
pub struct Finding { /* private fields */ }
Expand description

A single detection produced by a scanner.

A finding identifies the rule that matched, the exact source location of the match, and the rule-assigned severity and confidence.

Findings do not retain or copy the matched secret. Consumers can inspect the original source using Location::start and Location::end when they explicitly need access to the matched span.

Implementations§

Source§

impl Finding

Source

pub const fn rule_id(&self) -> &RuleId

Returns the stable identifier of the rule that produced this finding.

Source

pub const fn location(&self) -> &Location

Returns the exact source location of the detected span.

Source

pub const fn severity(&self) -> Severity

Returns the severity assigned by the matching rule.

Source

pub const fn confidence(&self) -> Confidence

Returns the confidence assigned by the matching rule.

Source

pub const fn remediation(&self) -> Option<Remediation>

Returns the recommended response to this finding, when one is known.

Source

pub fn explanation(&self, scanner: &Scanner) -> Option<Explanation>

Resolves typed explanation facts against the scanner that produced this finding.

A finding intentionally stores no duplicate detection-mode or explanation metadata. Resolution uses the scanner’s immutable compiled rule metadata and fails closed when the finding cannot be mapped unambiguously.

This operation performs no allocation and never accesses source text or the matched sensitive value.

Source

pub const fn is_critical(&self) -> bool

Returns true when this finding has critical severity.

Source

pub const fn is_high_priority(&self) -> bool

Returns true when this finding has high or critical severity.

Source

pub const fn is_high_confidence(&self) -> bool

Returns true when this finding has high confidence.

Trait Implementations§

Source§

impl Clone for Finding

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Finding

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for Finding

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for Finding

Source§

impl Hash for Finding

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for Finding

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Finding

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.