Struct ConsumeError

pub struct ConsumeError { /* private fields */ }

A list of errors that occured while consuming from a source.

Implementations

impl ConsumeError

pub fn new() -> ConsumeError

Create a new empty ConsumeError.

pub fn new_with(cause: ConsumeErrorType) -> ConsumeError

Create a new ConsumeError containing only cause.

pub fn new_from(causes: Vec<ConsumeErrorType>) -> ConsumeError

Create a new ConsumeError containing causes.

pub fn offset(self, by: usize) -> Self

Mutate all the errors to move the utf-8 character index at which they were caused by by.

Examples

use manger::{ ConsumeError, ConsumeErrorType::* };
assert_eq!(
    ConsumeError::new_from(
        vec![
            InvalidValue { index: 0 },
            InsufficientTokens { index: 5 }
        ]
    ).offset(2),
    ConsumeError::new_from(
        vec![
            InvalidValue { index: 2 },
            InsufficientTokens { index: 7 }
        ]
    )
);

pub fn into_causes(self) -> Vec<ConsumeErrorType>

Fetch a vector of the causes of this error.

This consume ownership of the error.

pub fn causes(&self) -> Vec<&ConsumeErrorType>

Fetch a vector of references to the causes of this error.

pub fn add_cause(&mut self, cause: ConsumeErrorType)

Pushes an extra cause for this error.

pub fn add_causes(&mut self, other_err: ConsumeError)

Pushes all the causes for other_err for this error.

Trait Implementations

impl Debug for ConsumeError

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

Formats the value using the given formatter.

impl PartialEq for ConsumeError

fn eq(&self, other: &ConsumeError) -> 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 StructuralPartialEq for ConsumeError