Struct lintrunner::lint_message::LintMessage

pub struct LintMessage {
    pub path: Option<String>,
    pub line: Option<usize>,
    pub char: Option<usize>,
    pub code: String,
    pub severity: LintSeverity,
    pub name: String,
    pub description: Option<String>,
    pub original: Option<String>,
    pub replacement: Option<String>,
}

Represents a single lint message. This version of the struct is used as the canonical protocol representation, intended to be serialized directly into JSON.

Fields

path: Option<String>

Path to the file this lint message pertains to.

This can either be an absolute path, or relative to the current working directory when lintrunner was invoked.

When the path is None, this message will be displayed as a general linter error.

line: Option<usize>

The line number that the lint message pertains to.

char: Option<usize>

The column number that the lint message pertains to.

code: String

Linter code (e.g. FLAKE8). Must match the code specified in the linter config.

severity: LintSeverity

The severity of the lint message.

name: String

The name of the type of lint message, e.g. “syntax error”

description: Option<String>

A more substantive description of the lint message. This can include suggestions for remediation, links to further documentation, etc.

original: Option<String>

The original text of the entire file, encoded as a utf-8 string.

replacement: Option<String>

If a fix was suggested, this is the replacement text of the entire file, encoded as a utf-8 string.

Trait Implementations

impl Clone for LintMessage

fn clone(&self) -> LintMessage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LintMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for LintMessage

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

Deserialize this value from the given Serde deserializer.

impl Serialize for LintMessage

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

Serialize this value into the given Serde serializer.