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 lint error reported by a plugin.

Create errors using LintError::error() / LintError::warning() directly, or more conveniently via ErrorBuilder (obtained from PluginSpec::error_builder()):

use nginx_lint_plugin::prelude::*;

let spec = PluginSpec::new("my-rule", "security", "Check something");
let err = spec.error_builder();

// Warning at a specific line/column
let warning = err.warning("message", 10, 5);
assert_eq!(warning.line, Some(10));

// Warning at a directive's location (most common pattern)
let config = nginx_lint_plugin::parse_string("autoindex on;").unwrap();
let directive = config.all_directives().next().unwrap();
let error = err.warning_at("use 'off'", directive)
    .with_fix(directive.replace_with("autoindex off;"));
assert_eq!(error.fixes.len(), 1);

Fields

rule: String

category: String

message: String

severity: Severity

line: Option<usize>

column: Option<usize>

fixes: Vec<Fix>

Implementations

impl LintError

pub fn error( rule: &str, category: &str, message: &str, line: usize, column: usize, ) -> Self

Create a new error with Error severity

pub fn warning( rule: &str, category: &str, message: &str, line: usize, column: usize, ) -> Self

Create a new error with Warning severity

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

Attach a fix to this error

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

Attach multiple fixes 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<'de> Deserialize<'de> for LintError

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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.