Struct FabError

pub struct FabError { /* private fields */ }

This is the recommended error type for Fabparse. This can be pretty-printed with the method print_trace(input), which will print a stack trace of the parsers with some surrounding context. An example is:

Location [“”]^["a1b2c3"] from parser Repeat

Location [“a1b2”]^[“c3”] from parser RepeatIter

From cause [TryReducerFailed]

There is also a print_trace_window(input) method that lets you customize the context window. The default is currently 10, but Fabparse reserves the right to increase this.

Implementations

impl FabError

pub fn print_trace<I: ?Sized + Sequence + Debug>(&self, parser_input: &I)

pub fn print_trace_window<I: ?Sized + Sequence + Debug>( &self, parser_input: &I, window: usize, )

Trait Implementations

impl Debug for FabError

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

Formats the value using the given formatter.

impl Display for FabError

This is the default error for Fabparse. It has a method print_trace(input) which prints a stack trace of the parser error, with context. An example trace on input “a1b2c3” is:

Location [“”]^["a1b2c3"] from parser Repeat

Location [“a1b2”]^[“c3”] from parser Repeat

From cause [TryReducerFailed]

This method requires that you pass in the input that generated the error. If you don’t the method may panic or print an incorrect stack trace.

This error type also has a method print_trace_window(input, window_size) which controls how much context is printed. By default, it will be 10 chars or items

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

Formats the value using the given formatter.

impl Error for FabError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

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

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl ParserError for FabError

fn from_parser_error<T: ?Sized>( input: *const T, parser_type: ParserType, ) -> Self

fn from_external_error<T: ?Sized, E: Error + Send + Sync + 'static>( input: *const T, parser_type: ParserType, cause: E, ) -> Self

fn get_loc(&self) -> Option<usize>

Get the location of the error. This is used in combinators to recognize the parser that made the furthest progress.

fn add_context<T: ?Sized + Sequence>( &mut self, input: *const T, parser_type: ParserType, )