Struct Finding 

#[non_exhaustive]
pub struct Finding {
    pub severity: Severity,
    pub family: Family,
    pub category: Cow<'static, str>,
    pub offset: Option<u64>,
    pub coordinates: Vec<Coordinate>,
    pub detail: String,
}

A typed deviation from what a family’s writer would emit, carrying its severity, where it sits, and that family’s own description.

This is the projection every family produces and every renderer consumes. A family’s own taxonomy is richer — it knows that a checksum failure was a group descriptor’s rather than an inode’s, as a value rather than as a word — and that taxonomy stays with the family; what crosses into here is what a report has to render and a policy has to threshold.

A JSON record, a rendered table row, and a SARIF result are projections of this, computed in FindingReport rather than at the edge: a projection written outside this crate would enumerate the fields from outside, where #[non_exhaustive] blocks the exhaustive destructure that keeps it complete, so a fact learned about a finding would silently stop being reported.

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.

severity: Severity

How serious the deviation is.

family: Family

The family that found it.

category: Cow<'static, str>

The subsystem it was found in, in the family’s own vocabulary.

offset: Option<u64>

Byte offset within the image, when the finding is at a known one. Absent where the family locates the fault by something it cannot convert — a group, an inode number, a directory entry — rather than by a place in the bytes.

coordinates: Vec<Coordinate>

The family’s own coordinates, in the order it reports them. Empty when the finding is about the image as a whole.

detail: String

A human-readable description.

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

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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 Eq for Finding

impl StructuralPartialEq for Finding