Struct Invalid

pub struct Invalid { /* private fields */ }

An error that has no details around what went wrong other than a RetryRequirement if the error is not fatal.

This is the most performant and simplistic catch-all retryable error, but it doesn’t provide any context to debug problems well.

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

Example

use dangerous::{Input, Invalid};

let error: Invalid = dangerous::input(b"").read_all(|r| {
    r.read_u8()
}).unwrap_err();

assert_eq!(
    error.to_string(),
    "invalid input: needs 1 byte more to continue processing",
);

Implementations

impl Invalid

pub fn fatal() -> Self

Create a fatal Invalid error.

pub fn retry(requirement: RetryRequirement) -> Self

Create a retryable Invalid error.

Trait Implementations

impl Clone for Invalid

fn clone(&self) -> Invalid

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Invalid

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

Formats the value using the given formatter.

impl<'o> Dependant<'o> for Invalid

Available on crate feature zc only.

type Static = Invalid

Always the exact same structure as Self but instead with a 'static lifetime.

impl Display for Invalid

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

Formats the value using the given formatter.

impl DisplayBase for Invalid

fn fmt(&self, w: &mut dyn Write) -> Result

Formats self given the provided Write.

impl Error for Invalid

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<'i, S> From<Expected<'i, S>> for Invalid

where S: Backtrace,

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

Converts to this type from the input type.

impl<'i> From<ExpectedLength<'i>> for Invalid

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

Converts to this type from the input type.

impl<'i> From<ExpectedValid<'i>> for Invalid

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

Converts to this type from the input type.

impl<'i> From<ExpectedValue<'i>> for Invalid

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

Converts to this type from the input type.

impl From<Option<RetryRequirement>> for Invalid

fn from(retry_requirement: Option<RetryRequirement>) -> Self

Converts to this type from the input type.

impl PartialEq for Invalid

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

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 to_retry_requirement() will return None, or false if Some(RetryRequirement).

impl<'i> WithContext<'i> for Invalid

const PASSTHROUGH: bool = true

If true indicates the error does not care about any provided contexts.

fn with_input(self, _input: impl Input<'i>) -> Self

Returns Self with a parent Input.

fn with_context(self, _context: impl Context) -> Self

Return Self with a context.

impl Copy for Invalid

impl StructuralPartialEq for Invalid