Struct Finding 

pub struct Finding {
    pub path: RepoPath,
    pub line: Option<usize>,
    pub severity: Severity,
    pub criterion: String,
    pub message: String,
    pub rule_line: Option<usize>,
}

One line of the report.

Fields

path: RepoPath

The file the finding is on.

line: Option<usize>

The line, when one applies.

severity: Severity

Error or warning.

criterion: String

The key of the criterion that the finding breaks, as TLMD_57.

message: String

The message, ending with the location of its rule in the schema when a schema rule raised it.

rule_line: Option<usize>

The line in the schema of the rule that raised it, where the check knows one: what a finding on the schema itself sits on when the schema’s own scaffold fails the rule. The report does not print it.

Implementations

impl Finding

pub fn new( path: RepoPath, line: Option<usize>, severity: Severity, criterion: &str, message: impl Into<String>, ) -> Finding

Build a finding that breaks criterion.

pub fn error( path: RepoPath, line: Option<usize>, criterion: &str, message: impl Into<String>, ) -> Finding

An error finding.

pub fn warning( path: RepoPath, line: Option<usize>, criterion: &str, message: impl Into<String>, ) -> Finding

A warning finding.

pub fn of_rule(self, line: usize) -> Finding

The finding, raised by the schema rule on line line of the schema; a rule with no line of its own, at 0, names none.

pub fn at(self, locator: &Locator) -> Finding

The finding, with the location of the schema rule that raised it appended to its message.

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<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Finding

fn deserialize<__D>( __deserializer: __D, ) -> Result<Finding, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Finding

impl Hash for Finding

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Finding

fn cmp(&self, other: &Finding) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Finding

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Finding

fn partial_cmp(&self, other: &Finding) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Finding

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Finding