Struct Finding 

#[non_exhaustive]
pub struct Finding {
    pub rule: Rule,
    pub severity: Severity,
    pub message: String,
    pub primary: SourceLocation,
    pub related: Vec<SourceLocation>,
    pub evidence: FindingEvidence,
    pub suggested_action: String,
    pub suppression: Option<Suppression>,
}

One rule diagnostic produced by analysis.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

rule: Rule

Rule that produced the finding.

severity: Severity

Configured impact.

message: String

Human-readable diagnostic message.

primary: SourceLocation

Main source span.

related: Vec<SourceLocation>

Additional spans involved in the finding.

evidence: FindingEvidence

Comparison data supporting the diagnostic.

suggested_action: String

Recommended remediation.

suppression: Option<Suppression>

Suppression metadata, when excluded from active totals.

Implementations

impl Finding

pub fn is_active(&self) -> bool

Returns whether the finding contributes to output totals and exit status.

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<'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 PartialEq for Finding

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