Struct dangerous::Expected

pub struct Expected<'i, S = FullContextStack> { /* fields omitted */ }

A catch-all error for all expected errors supported in this crate.

• Enable the full-context feature (enabled by default), for full-context stacks.
• It is generally recommended for better performance to have the box-expected feature enabled (enabled by default) if the structures being returned from parsing are smaller than or equal to ~128 bytes. This is because the Expected structure is 136 bytes large on 64 bit systems and successful parses may be hindered by the time to move the Result<T, Expected> value. By boxing the internals of Expected the size becomes only 8 bytes. When in doubt, write a benchmark.

See crate::error for additional documentation around the error system.

Implementations

impl<'i, S> Expected<'i, S> where
    S: ContextStack, 

pub fn display(&self) -> ErrorDisplay<'_, Self>

Returns an ErrorDisplay for formatting.

Trait Implementations

impl<'i> Debug for Expected<'i>

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

Formats the value using the given formatter.

impl<'i, S> Details<'i> for Expected<'i, S> where
    S: ContextStack, 

fn input(&self) -> &'i Input

The input in its entirety that was being processed when an error occurred.

fn span(&self) -> &'i Input

The specific section of input that caused an error.

fn expected(&self) -> Option<&Input>

The expected value, if applicable.

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

The description of what went wrong while processing the input.

fn context_stack(&self) -> &dyn ContextStack

The walkable ContextStack to the original context around the error that occurred.

impl<'i> Display for Expected<'i>

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

Formats the value using the given formatter.

impl<'i> Error for Expected<'i>

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

impl<'i, S> From<Expected<'i, S>> for Invalid where
    S: ContextStack, 

fn from(err: Expected<'i, S>) -> Self

Performs the conversion.

impl<'i, S> From<ExpectedLength<'i>> for Expected<'i, S> where
    S: ContextStackBuilder, 

fn from(err: ExpectedLength<'i>) -> Self

Performs the conversion.

impl<'i, S> From<ExpectedValid<'i>> for Expected<'i, S> where
    S: ContextStackBuilder, 

fn from(err: ExpectedValid<'i>) -> Self

Performs the conversion.

impl<'i, S> From<ExpectedValue<'i>> for Expected<'i, S> where
    S: ContextStackBuilder, 

fn from(err: ExpectedValue<'i>) -> Self

Performs the conversion.

impl<'i, S> FromContext<'i> for Expected<'i, S> where
    S: ContextStackBuilder, 

fn from_context<C>(self, input: &'i Input, context: C) -> Self where
    C: Context, 

Return Self with context.

impl<'i, S> IntoFatal for Expected<'i, S>

fn into_fatal(self) -> Self

Returns self with any RetryRequirement removed.

impl<'i, S> ToRetryRequirement for Expected<'i, S>

fn to_retry_requirement(&self) -> Option<RetryRequirement>

Returns the requirement, if applicable, to retry processing the Input.

fn is_fatal(&self) -> bool

Returns true if Self::to_retry_requirement() will return None, or false if Some(RetryRequirement).