Struct LintError 

pub struct LintError {
    pub rule: String,
    pub category: String,
    pub message: String,
    pub severity: Severity,
    pub line: Option<usize>,
    pub column: Option<usize>,
    pub fixes: Vec<Fix>,
}

A single lint diagnostic produced by a rule.

Every LintRule::check call returns a Vec<LintError>. Each error carries the rule name, category, a human-readable message, severity, an optional source location, and zero or more Fix proposals.

Building errors

use nginx_lint_common::linter::{LintError, Severity, Fix};

let error = LintError::new("my-rule", "style", "trailing whitespace", Severity::Warning)
    .with_location(10, 1)
    .with_fix(Fix::replace(10, "value  ", "value"));

Fields

rule: String

Rule identifier (e.g. "server-tokens-enabled").

category: String

Category the rule belongs to (e.g. "security", "style").

message: String

Human-readable description of the problem.

severity: Severity

Whether this is an error or a warning.

line: Option<usize>

1-indexed line number where the problem was detected.

column: Option<usize>

1-indexed column number where the problem was detected.

fixes: Vec<Fix>

Auto-fix proposals that can resolve this diagnostic.

Implementations

impl LintError

pub fn new( rule: &str, category: &str, message: &str, severity: Severity, ) -> Self

Create a new lint error without a source location.

Use with_location to attach line/column info and with_fix to attach auto-fix proposals.

pub fn with_location(self, line: usize, column: usize) -> Self

Attach a source location (1-indexed line and column) to this error.

pub fn with_fix(self, fix: Fix) -> Self

Append a single Fix proposal to this error.

pub fn with_fixes(self, fixes: Vec<Fix>) -> Self

Append multiple Fix proposals to this error.

Trait Implementations

impl Clone for LintError

fn clone(&self) -> LintError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LintError

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

Formats the value using the given formatter.

impl Serialize for LintError

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

where __S: Serializer,

Serialize this value into the given Serde serializer.