Struct LintResult

pub struct LintResult<'s> {
    pub parser_diagnostics: Vec<Diagnostic>,
    pub rule_results: HashMap<&'static str, RuleResult>,
    pub directive_diagnostics: Vec<DirectiveError>,
    pub store: &'s CstRuleStore,
    pub parsed: SyntaxNode,
    pub file_id: usize,
    pub verbose: bool,
    pub fixed_code: Option<String>,
}

The result of linting a file.

Fields

parser_diagnostics: Vec<Diagnostic>

Any diagnostics (errors, warnings, etc) emitted from the parser

rule_results: HashMap<&'static str, RuleResult>

The diagnostics emitted by each rule run

directive_diagnostics: Vec<DirectiveError>

Any warnings or errors emitted by the directive parser

store: &'s CstRuleStore

parsed: SyntaxNode

file_id: usize

verbose: bool

fixed_code: Option<String>

Implementations

impl LintResult<'_>

pub fn diagnostics(&self) -> impl Iterator<Item = &Diagnostic>

Get all of the diagnostics thrown during linting, in the order of parser diagnostics, then the diagnostics of each rule sequentially.

pub fn outcome(&self) -> Outcome

The overall outcome of linting this file (failure, warning, success, etc)

pub fn fix(&mut self, dirty: bool, file: &File) -> Option<String>

Attempt to automatically fix any fixable issues and return the fixed code.

This will not run if there are syntax errors unless dirty is set to true.

Trait Implementations

impl<'s> Clone for LintResult<'s>

fn clone(&self) -> LintResult<'s>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'s> Debug for LintResult<'s>

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

Formats the value using the given formatter.