Struct litrs::Error

pub struct Error { /* fields omitted */ }

Errors during parsing.

This type should be seen primarily for error reporting and not for catching specific cases. The span and error kind are not guaranteed to be stable over different versions of this library, meaning that a returned error can change from one version to the next. There are simply too many fringe cases that are not easy to classify as a specific error kind. It depends entirely on the specific parser code how an invalid input is categorized.

Consider these examples:

• '\ can be seen as
  • invalid escape in character literal, or
  • unterminated character literal.
• ''' can be seen as
  • empty character literal, or
  • unescaped quote character in character literal.
• 0b64 can be seen as
  • binary integer literal with invalid digit 6, or
  • binary integer literal with invalid digit 4, or
  • decimal integer literal with invalid digit b, or
  • decimal integer literal 0 with unknown type suffix b64.

If you want to see more if these examples, feel free to check out the unit tests of this library.

While this library does its best to emit sensible and precise errors, and to keep the returned errors as stable as possible, full stability cannot be guaranteed.

Implementations

impl Error

pub fn span(&self) -> Option<Range<usize>>

Returns a span of this error, if available. Note: this is not stable. See the documentation of this type for more information.

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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

The lower-level source of this error, if any.

fn backtrace(&self) -> Option<&Backtrace>

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

Returns a stack backtrace, if available, of where this error occurred.

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