Enum RulesError 

pub enum RulesError {
    Read {
        path: String,
        source: Error,
    },
    Parse {
        path: String,
        source: Box<Error>,
    },
    UnknownLanguage {
        rule: String,
        language: String,
    },
    GrammarUnavailable {
        rule: String,
        language: String,
    },
    PatternCompile {
        rule: String,
        message: String,
    },
    QueryRejected {
        rule: String,
        message: String,
        query: String,
    },
    SourceParse {
        rule: String,
        message: String,
    },
    NotAutoApplicable {
        rule: String,
        safety: String,
    },
    NotIdempotent {
        rule: String,
    },
}

Anything that can go wrong loading, compiling, or running a rule.

Variants

Read

A rule file could not be read.

Fields

path: String

The path that failed to read.

source: Error

The underlying I/O error.

Parse

A rule file could not be parsed as TOML.

Fields

path: String

The path that failed to parse.

source: Box<Error>

The underlying TOML error.

UnknownLanguage

A rule referenced a language the engine does not know.

Fields

rule: String

The offending rule id.

language: String

The language string that did not resolve.

GrammarUnavailable

A rule’s language is known but its grammar was not compiled into this build.

Fields

rule: String

The offending rule id.

language: String

The language whose grammar is missing.

PatternCompile

A pattern snippet failed to compile into a tree-sitter query.

Fields

rule: String

The offending rule id.

message: String

What went wrong compiling the snippet.

QueryRejected

The compiled query was rejected by tree-sitter. This is an engine bug if it happens for a snippet that parsed cleanly, so it carries the generated query for debugging.

Fields

rule: String

The offending rule id.

message: String

The tree-sitter query error.

query: String

The generated S-expression query.

SourceParse

Source text could not be parsed in the rule’s grammar.

Fields

rule: String

The offending rule id.

message: String

The parse failure detail.

NotAutoApplicable

auto_apply was called on a rule whose safety is above the machine-applicable threshold; it must be applied with explicit opt-in.

Fields

rule: String

The offending rule id.

safety: String

The rule’s declared safety tier.

NotIdempotent

A fix did not reach a fixed point: re-running it after applying still produced changes.

Fields

rule: String

The offending rule id.

Trait Implementations

impl Debug for RulesError

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

Formats the value using the given formatter.

impl Display for RulesError

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

Formats the value using the given formatter.

impl Error for RulesError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.