Struct YggdrasilError 

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

Parse-related error type.

Fields

variant: ErrorKind<R>

Variant of the error

location: InputLocation

Location within the input string

line_col: LineColLocation

Line/column within the input string

Implementations

impl<R> YggdrasilError<R>

where R: YggdrasilRule,

pub fn new_from_offset( variant: ErrorKind<R>, pos: Position<'_>, ) -> YggdrasilError<R>

Creates Error from ErrorVariant and Position.

Examples

let error = YggdrasilError::new_from_offset(
    ErrorKind::ParsingError {
        positives: vec![Rule::open_paren],
        negatives: vec![Rule::closed_paren],
    },
    pos,
);

println!("{}", error);

pub fn new_from_span( variant: ErrorKind<R>, span: TextSpan<'_>, ) -> YggdrasilError<R>

Creates Error from ErrorVariant and Span.

Examples

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

println!("{}", error);

pub fn invalid_node(expect: R, span: TextSpan<'_>) -> YggdrasilError<R>

unable to create node

pub fn missing_tag( expect: Cow<'static, str>, span: TextSpan<'_>, ) -> YggdrasilError<R>

unable to create node

pub fn missing_rule(expect: R, span: TextSpan<'_>) -> YggdrasilError<R>

missing rule

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

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

Examples

YggdrasilError::new_from_offset(
    ErrorKind::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 YggdrasilError::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) -> YggdrasilError<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

YggdrasilError::new_from_offset(
    ErrorKind::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(),
});

Trait Implementations

impl<R> Clone for YggdrasilError<R>

where R: Clone,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<R> Debug for YggdrasilError<R>

where R: Debug,

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

Formats the value using the given formatter.

impl<R> Display for YggdrasilError<R>

where R: YggdrasilRule,

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

Formats the value using the given formatter.

impl<R> Hash for YggdrasilError<R>

where R: Hash,

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

where __H: Hasher,

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 for YggdrasilError<R>

where R: PartialEq,

fn eq(&self, other: &YggdrasilError<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 for YggdrasilError<R>

where R: Eq,

impl<R> StructuralPartialEq for YggdrasilError<R>