Enum DecodeFailure 

pub enum DecodeFailure<E> {
    Incomplete {
        required_total: NonZeroUsize,
    },
    Invalid {
        source: E,
        consumed: Option<NonZeroUsize>,
    },
}

Failure reported by crate::Codec::decode.

This type separates stream-control failures from codec-domain failures. Incomplete tells buffered adapters to preserve the current input tail and request more units. Invalid carries the codec-specific malformed, non-canonical, or otherwise invalid input error.

Type Parameters

• E: Codec-specific invalid-input error type.

Variants

Incomplete

The visible input is a valid prefix but not enough to decode a value.

Fields

required_total: NonZeroUsize

Non-zero total units required from the current value start.

Invalid

The input is invalid for the codec.

Fields

source: E

Codec-specific invalid-input error.

consumed: Option<NonZeroUsize>

Invalid units that may be consumed by a non-strict policy.

Implementations

impl<E> DecodeFailure<E>

pub const fn incomplete(required_total: NonZeroUsize) -> Self

Creates an incomplete-input decode failure.

Parameters

• required_total: Non-zero total units required from the current value start.

Returns

Returns an incomplete decode failure.

pub const fn invalid(source: E, consumed: NonZeroUsize) -> Self

Creates an invalid-input decode failure with a consumption hint.

Parameters

• source: Codec-specific invalid-input error.
• consumed: Invalid input units that may be consumed.

Returns

Returns an invalid decode failure.

pub const fn invalid_without_consumed(source: E) -> Self

Creates an invalid-input decode failure without a consumption hint.

Parameters

• source: Codec-specific invalid-input error.

Returns

Returns an invalid decode failure.

pub const fn required_total(&self) -> Option<NonZeroUsize>

Returns the total input units required for an incomplete prefix.

Returns

Returns Some(required_total) for incomplete failures, or None for invalid-input failures.

pub const fn invalid_source(&self) -> Option<&E>

Borrows the codec-specific invalid-input error.

Returns

Returns Some(source) for invalid-input failures, or None for incomplete failures.

pub const fn consumed_units(&self) -> Option<NonZeroUsize>

Returns invalid units that may be consumed by a non-strict policy.

Returns

Returns Some(consumed) when the invalid failure carries a consumption hint, or None otherwise.

Trait Implementations

impl<E: Clone> Clone for DecodeFailure<E>

fn clone(&self) -> DecodeFailure<E>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<E: Copy> Copy for DecodeFailure<E>

impl<E: Debug> Debug for DecodeFailure<E>

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

Formats the value using the given formatter.

impl<E: Eq> Eq for DecodeFailure<E>

impl<E: Hash> Hash for DecodeFailure<E>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<E: PartialEq> PartialEq for DecodeFailure<E>

fn eq(&self, other: &DecodeFailure<E>) -> 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<E: PartialEq> StructuralPartialEq for DecodeFailure<E>