Struct boreal::compiler::AddRuleError

pub struct AddRuleError {
    pub path: Option<PathBuf>,
    /* private fields */
}

Error when adding a rule to a Compiler.

Fields

path: Option<PathBuf>

The path to the file containing the error.

None if the error happens on a raw string (Compiler::add_rules_str).

Implementations

impl AddRuleError

pub fn to_short_description(&self, input_name: &str, input: &str) -> String

Convert to a displayable, single-lined description.

Arguments

• input_name: a name for the input, used at the beginning of the description: <filename>:<line>:<column>: <description>.
• input: the input given to boreal_parser::parse that generated the error.

pub fn to_diagnostic(&self) -> Diagnostic<()>

Convert to a Diagnostic.

This can be used to display the error in a more user-friendly manner than the simple Self::to_short_description.

Trait Implementations

impl Debug for AddRuleError

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

Formats the value using the given formatter.