Struct Finding 

#[non_exhaustive]
pub struct Finding {
    pub kind: MetadataKind,
    pub location: String,
    pub field: Option<String>,
    pub bytes: u64,
    pub value: Option<MetadataValue>,
}

One piece of metadata found in a file.

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.

kind: MetadataKind

What kind of identifying information this is.

location: String

Where it lives in the file’s structure, as a format-domain identifier — APP1 (Exif), tEXt, /Info /Author. Stable across releases; front-ends may show it verbatim.

field: Option<String>

The field’s name within that structure, where the format names its fields.

bytes: u64

Size of the item in bytes.

value: Option<MetadataValue>

The value — present only when InspectOptions::include_values was set.

Implementations

impl Finding

pub fn new(kind: MetadataKind, location: impl Into<String>, bytes: u64) -> Self

A finding with no field name and no value.

pub fn with_field(self, field: impl Into<String>) -> Self

Attach the field name this item was stored under.

pub fn with_value( self, options: &InspectOptions, value: impl FnOnce() -> MetadataValue, ) -> Self

Attach the value, but only if options asked for it.

Taking the options here rather than at the call site means a handler cannot leak a value by forgetting to check — the check lives in one place and every handler goes through it.

pub const fn sensitivity(&self) -> Sensitivity

How directly this finding exposes its subject.

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

impl PartialEq for Finding

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Finding