Struct Error

pub struct Error<R> {
    pub variant: ErrorVariant<R>,
    pub location: InputLocation,
    pub line_col: LineColLocation,
    /* private fields */
}

Parse-related error type.

Fields

variant: ErrorVariant<R>

Variant of the error

location: InputLocation

Location within the input string

line_col: LineColLocation

Line/column within the input string

Implementations

impl<R: RuleType> Error<R>

pub fn new_from_pos(variant: ErrorVariant<R>, pos: Position<'_>) -> Error<R>

Creates Error from ErrorVariant and Position.

Examples

let error = Error::new_from_pos(
    ErrorVariant::ParsingError {
        positives: vec![Rule::open_paren],
        negatives: vec![Rule::closed_paren],
    },
    pos
);

println!("{}", error);

pub fn new_from_span(variant: ErrorVariant<R>, span: Span<'_>) -> Error<R>

Creates Error from ErrorVariant and Span.

Examples

let error = Error::new_from_span(
    ErrorVariant::ParsingError {
        positives: vec![Rule::open_paren],
        negatives: vec![Rule::closed_paren],
    },
    span
);

println!("{}", error);

pub fn with_path(self, path: &str) -> Error<R>

Returns Error variant with path which is shown when formatted with Display.

Examples

Error::new_from_pos(
    ErrorVariant::ParsingError {
        positives: vec![Rule::open_paren],
        negatives: vec![Rule::closed_paren],
    },
    pos
).with_path("file.rs");

pub fn path(&self) -> Option<&str>

Returns the path set using Error::with_path().

Examples

let error = error.with_path("file.rs");
assert_eq!(Some("file.rs"), error.path());

pub fn line(&self) -> &str

Returns the line that the error is on.

pub fn renamed_rules<F>(self, f: F) -> Error<R>

where F: FnMut(&R) -> String,

Renames all Rules if this is a ParsingError. It does nothing when called on a CustomError.

Useful in order to rename verbose rules or have detailed per-Rule formatting.

Examples

Error::new_from_pos(
    ErrorVariant::ParsingError {
        positives: vec![Rule::open_paren],
        negatives: vec![Rule::closed_paren],
    },
    pos
).renamed_rules(|rule| {
    match *rule {
        Rule::open_paren => "(".to_owned(),
        Rule::closed_paren => "closed paren".to_owned()
    }
});

pub fn parse_attempts(&self) -> Option<ParseAttempts<R>>

Get detailed information about errored rules sequence. Returns Some(results) only for ParsingError.

pub fn parse_attempts_error( &self, input: &str, rule_to_message: &RuleToMessageFn<R>, is_whitespace: &IsWhitespaceFn, ) -> Option<Error<R>>

Get error message based on parsing attempts. Returns None in case self parse_attempts is None.

Trait Implementations

impl<R: Clone> Clone for Error<R>

fn clone(&self) -> Error<R>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<R: Debug> Debug for Error<R>

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

Formats the value using the given formatter.

impl<R: RuleType> Display for Error<R>

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

Formats the value using the given formatter.

impl<R> Error for Error<R>

where Self: Debug + Display,

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.

impl<R: Hash> Hash for Error<R>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<R: PartialEq> PartialEq for Error<R>

fn eq(&self, other: &Error<R>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<R: Eq> Eq for Error<R>

impl<R> StructuralPartialEq for Error<R>