Struct Finding 

pub struct Finding {
    pub rule: RuleId,
    pub path: Option<Utf8PathBuf>,
    pub line: Option<usize>,
    pub detail: String,
}

One violation found by a check.

Fields

rule: RuleId

The requirement the violation breaks.

path: Option<Utf8PathBuf>

The offending file, when the violation has one.

line: Option<usize>

The offending line within path, when the violation has one.

detail: String

What is wrong, stated for the reader who will fix it.

Implementations

impl Finding

pub fn on_file( rule: RuleId, path: impl Into<Utf8PathBuf>, detail: impl Into<String>, ) -> Self

A finding anchored to a file.

pub fn on_line( rule: RuleId, path: impl Into<Utf8PathBuf>, line: usize, detail: impl Into<String>, ) -> Self

A finding anchored to one line of a file.

pub fn global(rule: RuleId, detail: impl Into<String>) -> Self

A finding about the repository as a whole.

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