Struct ContextError

pub struct ContextError<C = StrContext> { /* private fields */ }

Available on crate feature dep_winnow only.

Accumulate context while backtracking errors

See the [tutorial][crate::_tutorial::chapter_7#error-adaptation-and-rendering] for an example of how to adapt this to an application error with custom rendering.

Implementations

impl<C> ContextError<C>

pub fn new() -> ContextError<C>

Create an empty error

pub fn context(&self) -> impl Iterator<Item = &C>

Access context from Parser::context

pub fn cause(&self) -> Option<&(dyn Error + Send + Sync + 'static)>

Originating std::error::Error

Trait Implementations

impl<C, I> AddContext<I, C> for ContextError<C>

where I: Stream,

fn add_context( self, _input: &I, _token_start: &<I as Stream>::Checkpoint, context: C, ) -> ContextError<C>

Append to an existing error custom data

impl<C> Clone for ContextError<C>

where C: Clone,

fn clone(&self) -> ContextError<C>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C> Debug for ContextError<C>

where C: Debug,

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

Formats the value using the given formatter.

impl<C> Default for ContextError<C>

fn default() -> ContextError<C>

Returns the “default value” for a type.

impl Display for ContextError

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

Formats the value using the given formatter.

impl<C> ErrorConvert<ContextError<C>> for ContextError<C>

fn convert(self) -> ContextError<C>

Transform to another error type

impl<C, I, E> FromExternalError<I, E> for ContextError<C>

where E: Error + Send + Sync + 'static,

fn from_external_error(_input: &I, e: E) -> ContextError<C>

Like ParserError::from_input but also include an external error.

impl<I, C> ParserError<I> for ContextError<C>

where I: Stream,

type Inner = ContextError<C>

Generally, Self

fn from_input(_input: &I) -> ContextError<C>

Creates an error from the input position

fn into_inner( self, ) -> Result<<ContextError<C> as ParserError<I>>::Inner, ContextError<C>>

Unwrap the mode, returning the underlying error, if present

fn assert(input: &I, _message: &'static str) -> Self

where I: Debug,

Process a parser assertion

fn incomplete(input: &I, _needed: Needed) -> Self

There was not enough data to determine the appropriate action

fn append(self, _input: &I, _token_start: &<I as Stream>::Checkpoint) -> Self

Like ParserError::from_input but merges it with the existing error.

fn or(self, other: Self) -> Self

Combines errors from two different parse branches.

fn is_backtrack(&self) -> bool

Is backtracking and trying new parse branches allowed?

fn is_incomplete(&self) -> bool

Is more data Needed

fn needed(&self) -> Option<Needed>

Extract the Needed data, if present

impl<C> PartialEq for ContextError<C>

where C: PartialEq,

fn eq(&self, other: &ContextError<C>) -> 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.