Struct ParseError

pub struct ParseError<'t> {
    pub text: &'t str,
    pub message: String,
}

Tracks an error that occurred while parsing. The parse error records the input text it saw, which will be some suffix of the original input, along with a message.

The actual ParseResult type tracks a set of parse errors. When parse errors are generated, there is just one (e.g., “expected identifier”), but when there are choice points in the grammar (e.g., when parsing an enum), those errors can be combined by require_unambiguous.

Fields

text: &'t str

Input that triggered the parse error. Some suffix of the original input.

message: String

Message describing what was expected.

Implementations

impl<'t> ParseError<'t>

pub fn at(text: &'t str, message: String) -> Set<Self>

Creates a single parse error at the given point. Returns a set so that it can be wrapped as a ParseResult.

pub fn offset(&self, text: &str) -> usize

Offset of this error relative to the starting point text

pub fn consumed_before<'s>(&self, text: &'s str) -> &'s str

Returns the text that was consumed before this error occurred, with text is the starting point.

Trait Implementations

impl<'t> Clone for ParseError<'t>

fn clone(&self) -> ParseError<'t>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'t> Debug for ParseError<'t>

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

Formats the value using the given formatter.

impl<'t> Ord for ParseError<'t>

fn cmp(&self, other: &ParseError<'t>) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<'t> PartialEq for ParseError<'t>

fn eq(&self, other: &ParseError<'t>) -> 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<'t> PartialOrd for ParseError<'t>

fn partial_cmp(&self, other: &ParseError<'t>) -> Option<Ordering>

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

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

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

impl<'t> Eq for ParseError<'t>

impl<'t> StructuralPartialEq for ParseError<'t>