Struct ParseError 

pub struct ParseError {
    pub kind: ParseErrorKind,
    pub failed_format: Option<&'static str>,
}

A minimal runtime parser failure.

Vest parsers work on progressively sliced inputs, so a globally meaningful byte offset is not available unless the caller explicitly threads that information through the parser stack. Instead, this error carries a coarse-grained failure kind plus the name of the innermost DSL-defined format that failed. With the error-trace feature it also retains the full named-format call stack (at the cost of heap allocation).

Fields

kind: ParseErrorKind

The kind of failure that occurred.

failed_format: Option<&'static str>

The innermost named format known to have failed.

Implementations

impl ParseError

pub exec fn new(kind: ParseErrorKind) -> e : Self

ensures

e.kind == kind,

Creates a new parse error.

pub exec fn push_format(self, current_format: &'static str) -> Self

Pushes one named format onto the failing format stack.

The first pushed format becomes current_format, so current_format continues to refer to the innermost failing named format even as outer formats append themselves during propagation.

pub exec fn format_trace(&self) -> &[&'static str]

Returns the recorded format stack as an innermost-first slice.

impl ParseError

pub exec fn unexpected_eof() -> e : Self

ensures

e.kind == ParseErrorKind::UnexpectedEof,

Creates an unexpected end-of-input error.

pub exec fn expecting_eof() -> Self

Creates an expecting end-of-input error.

pub exec fn invalid_tag() -> Self

Creates an invalid-tag error.

pub exec fn invalid_choice() -> Self

Creates an invalid-choice error.

pub exec fn invalid_length() -> Self

Creates an invalid-length error.

pub exec fn length_mismatch() -> Self

Creates a length-mismatch error.

pub exec fn predicate_failed() -> Self

Creates a predicate-failed error.

pub exec fn cond_rejected() -> Self

Creates a condition-rejected error.

pub exec fn non_canonical() -> Self

Creates a non-canonical-encoding error.

pub exec fn overflow() -> e : Self

ensures

e.kind == ParseErrorKind::Overflow,

Creates an overflow error.

pub exec fn recursion_limit_exceeded() -> Self

Creates a recursion-limit-exceeded error.

pub exec fn custom(msg: &'static str) -> Self

Creates a custom error with the given message.

Trait Implementations

impl Clone for ParseError

exec fn clone(&self) -> Self

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

Performs copy-assignment from source.

impl Debug for ParseError

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

Formats the value using the given formatter.

impl Display for ParseError

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

Formats the value using the given formatter.

impl Eq for ParseError

impl Error for ParseError

Available on crate feature std only.

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 PartialEq for ParseError

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