Struct LintFinding 

pub struct LintFinding {
    pub severity: LintSeverity,
    pub code: &'static str,
    pub stage: Option<String>,
    pub message: String,
    pub fix: Option<String>,
}

One thing worth telling the author about.

Serialize only: code is a &'static str pointing at a literal in this file, which no deserializer can produce.

Fields

severity: LintSeverity

code: &'static str

Stable slug ("unknown-tool"), so a finding can be referenced in an issue or grepped for in daemon logs without quoting prose.

stage: Option<String>

The stage it belongs to, when it belongs to one.

message: String

What is wrong.

fix: Option<String>

What to do about it. Rendered on its own indented line.

Implementations

impl LintFinding

pub fn is_error(&self) -> bool

Whether this finding should fail the command.

pub fn one_line(&self) -> String

One-line rendering for a log record: stage 'x': message.

Trait Implementations

impl Clone for LintFinding

fn clone(&self) -> LintFinding

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for LintFinding

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

Formats the value using the given formatter.

impl Eq for LintFinding

impl PartialEq for LintFinding

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for LintFinding

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for LintFinding