Struct Finding 

#[non_exhaustive]
pub struct Finding {
    pub check_id: &'static str,
    pub severity: Severity,
    pub clip: Option<String>,
    pub bone: Option<String>,
    pub time_s: Option<f32>,
    pub measured: Option<Value>,
    pub expected: Option<Value>,
    pub message: String,
    pub diagnostic: bool,
}

A structured lint result emitted by a crate::Check.

The JSON shape is part of animsmith’s automation contract. The Rust struct is marked non_exhaustive so new optional context fields can be added before 1.0 without forcing downstream construction through struct literals.

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.

check_id: &'static str

Stable check id such as "loop-seam".

severity: Severity

Effective severity after any non-diagnostic override.

clip: Option<String>

Clip associated with the finding, when the finding is clip-local.

bone: Option<String>

Bone associated with the finding, when applicable.

time_s: Option<f32>

Time in seconds associated with the finding, when applicable.

measured: Option<Value>

Measured value that triggered the finding.

expected: Option<Value>

Expected value or threshold for the finding.

message: String

Human-readable explanation.

diagnostic: bool

A diagnostic (a “skipped: …” note about an unmet prerequisite), not a judgement of the content. Diagnostics are exempt from per-check severity overrides — a check declared severity = "error" must never turn a “roles unresolved” note into a false failure. Not serialized: the JSON output shape is unchanged.

Implementations

impl Finding

pub fn new( check_id: &'static str, severity: Severity, message: impl Into<String>, ) -> Self

Construct a finding with no optional context fields set.

pub fn as_diagnostic(self) -> Self

Mark this finding a diagnostic (see Finding::diagnostic): emitted at Note, exempt from severity overrides.

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

Attach a clip name.

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

Attach a bone name.

pub fn time(self, t: f32) -> Self

Attach a clip time in seconds.

pub fn measured(self, v: impl Into<Value>) -> Self

Attach a measured value.

pub fn expected(self, v: impl Into<Value>) -> Self

Attach an expected value or threshold.

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