Enum Err

pub enum Err<E> {
    Incomplete(Needed),
    Error(E),
    Failure(E),
}

The Err enum indicates the parser was not successful

It has three cases:

• Incomplete indicates that more data is needed to decide. The Needed enum can contain how many additional bytes are necessary. If you are sure your parser is working on full data, you can wrap your parser with the complete combinator to transform that case in Error
• Error means some parser did not succeed, but another one might (as an example, when testing different branches of an alt combinator)
• Failure indicates an unrecoverable error. As an example, if you recognize a prefix to decide on the next parser to apply, and that parser fails, you know there’s no need to try other parsers, you were already in the right branch, so the data is invalid

Variants

Incomplete(Needed)

There was not enough data

Error(E)

The parser had an error (recoverable)

Failure(E)

The parser had an unrecoverable error: we got to the right branch and we know other branches won’t work, so backtrack as fast as possible

Implementations

impl<E> Err<E>

pub fn is_incomplete(&self) -> bool

Tests if the result is Incomplete

pub fn map<E2, F>(self, f: F) -> Err<E2>

where F: FnOnce(E) -> E2,

Applies the given function to the inner error

pub fn convert<F>(e: Err<F>) -> Self

where E: From<F>,

Automatically converts between errors if the underlying type supports it

impl<T> Err<(T, ErrorKind)>

pub fn map_input<U, F>(self, f: F) -> Err<(U, ErrorKind)>

where F: FnOnce(T) -> U,

Maps Err<(T, ErrorKind)> to Err<(U, ErrorKind)> with the given F: T -> U

impl<T> Err<Error<T>>

pub fn map_input<U, F>(self, f: F) -> Err<Error<U>>

where F: FnOnce(T) -> U,

Maps Err<error::Error<T>> to Err<error::Error<U>> with the given F: T -> U

Trait Implementations

impl<E: Clone> Clone for Err<E>

fn clone(&self) -> Err<E>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<E: Debug> Debug for Err<E>

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

Formats the value using the given formatter.

impl<E> Display for Err<E>

where E: Debug,

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

Formats the value using the given formatter.

impl<E: PartialEq> PartialEq for Err<E>

fn eq(&self, other: &Err<E>) -> 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<E: Eq> Eq for Err<E>

impl<E> StructuralPartialEq for Err<E>