Struct chomp::parsers::Error

pub struct Error<I>(_);

Common error for the basic Chomp parsers.

This is the common error for the basic Chomp parsers. It will contain information about what a parser expected or if it encountered something unexpected (in the case of user supplied predicates, eg. satisfy).

This is coupled with the state found in the error state of the ParseResult type.

Methods

impl<I> Error<I>

fn new() -> Self

Creates a new Unexpected error.

Should be used when the error value is not important.

fn unexpected() -> Self

Creates a new Unexpected error.

Should be used when the token was unexpected, as in the case of satisfy where a user provided predicate is provided.

fn expected(i: I) -> Self

Creates a new Expected error.

Should be used when a specific token was expected.

fn expected_token(&self) -> Option<&I>

Returns Some(&I) if a specific token was expected, None otherwise.

Trait Implementations

impl<I: Clone> Clone for Error<I>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<I: Debug> Debug for Error<I>

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<I: Eq> Eq for Error<I>

impl<I: PartialEq> PartialEq for Error<I>

fn eq(&self, __arg_0: &Error<I>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, __arg_0: &Error<I>) -> bool

This method tests for !=.

impl<I: Ord> Ord for Error<I>

fn cmp(&self, __arg_0: &Error<I>) -> Ordering

This method returns an Ordering between self and other.

impl<I: PartialOrd> PartialOrd for Error<I>

fn partial_cmp(&self, __arg_0: &Error<I>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, __arg_0: &Error<I>) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, __arg_0: &Error<I>) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, __arg_0: &Error<I>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, __arg_0: &Error<I>) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<I: Hash> Hash for Error<I>

fn hash<__HI: Hasher>(&self, __arg_0: &mut __HI)

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

impl<I> Display for Error<I> where
    I: Debug, 

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

Formats the value using the given formatter.

impl<I: Any + Debug> Error for Error<I>

fn description(&self) -> &str

A short description of the error.

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

The lower-level cause of this error, if any.