Struct Finding 

#[non_exhaustive]
pub struct Finding {
    pub severity: Severity,
    pub rule: String,
    pub path: Path,
    pub message: String,
}

One thing a validator has to say about 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.

severity: Severity

How serious it is.

rule: String

A stable identifier for the check that produced this, e.g. structure.reference.dangling or where.IfcRoot.WR1. Callers filter and suppress on this, so it is part of the contract.

path: Path

Where the problem is.

message: String

What is wrong, in one sentence, without restating the rule id.

Implementations

impl Finding

pub fn error( rule: impl Into<String>, path: Path, message: impl Into<String>, ) -> Self

A schema violation.

pub fn warning( rule: impl Into<String>, path: Path, message: impl Into<String>, ) -> Self

A legal but suspicious condition.

pub fn evaluation_error( rule: impl Into<String>, path: Path, message: impl Into<String>, ) -> Self

An implemented rule that could not be decided for one instance.

rule is the rule’s own id, so a caller filtering on it sees both verdicts; the severity says which one this is.

pub fn unsupported( rule: impl Into<String>, path: Path, message: impl Into<String>, ) -> Self

A rule this validator did not evaluate.

Trait Implementations

impl Clone for Finding

fn clone(&self) -> Self

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

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

Formats the value using the given formatter.

impl Eq for Finding

impl PartialEq for Finding

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Finding