Enum CodecDecodeError 

pub enum CodecDecodeError<E> {
    Decode {
        source: E,
        input_index: usize,
    },
    Incomplete {
        input_index: usize,
        required_total: usize,
        available: usize,
    },
    TrailingInput {
        consumed: usize,
        remaining: usize,
    },
    InvalidInputIndex {
        index: usize,
        len: usize,
    },
    InvalidOutputIndex {
        index: usize,
        len: usize,
    },
}

Error reported by codec-backed value and buffered decoder adapters.

The wrapped codec remains responsible for domain-specific decode failures. This type adds adapter-level failures that cannot be represented by the wrapped codec itself, such as a value decoder receiving too few units before it can safely call crate::Codec::decode_unchecked or a buffered decoder receiving an invalid output start index.

Variants

Decode

The wrapped codec reported a decode error.

Fields

source: E

Error returned by the wrapped codec.

input_index: usize

Absolute input index at which the adapter called the wrapped codec.

Incomplete

The adapter could not safely call the wrapped codec because input ended.

Fields

input_index: usize

Absolute input index where the incomplete value starts.

required_total: usize

Total units required from input_index.

available: usize

Units available from input_index.

TrailingInput

A whole-value decode succeeded but left trailing input units.

Fields

consumed: usize

Units consumed by the decoded value.

remaining: usize

Extra units left after the decoded value.

InvalidInputIndex

The caller supplied an input index outside the input slice.

Fields

index: usize

Invalid input index supplied by the caller.

len: usize

Length of the input slice.

InvalidOutputIndex

The caller supplied an output index outside the output slice.

Fields

index: usize

Invalid output index supplied by the caller.

len: usize

Length of the output slice.

Implementations

impl<E> CodecDecodeError<E>

pub const fn decode(source: E, input_index: usize) -> Self

Creates an error wrapping a codec-specific decode error.

Parameters

• source: Error returned by the wrapped codec.
• input_index: Absolute input index used for the codec call.

Returns

Returns a codec decode error wrapper.

pub const fn incomplete( input_index: usize, required_total: usize, available: usize, ) -> Self

Creates an adapter-level incomplete-input error.

Parameters

• input_index: Absolute input index where the incomplete value starts.
• required_total: Total units required from input_index.
• available: Units available from input_index.

Returns

Returns an incomplete-input error.

pub const fn trailing_input(consumed: usize, remaining: usize) -> Self

Creates a trailing-input error for whole-value decoding.

Parameters

• consumed: Units consumed by the decoded value.
• remaining: Extra units left after the decoded value.

Returns

Returns a trailing-input error.

pub const fn invalid_input_index(index: usize, len: usize) -> Self

Creates an invalid-input-index error.

Parameters

• index: Invalid input index supplied by the caller.
• len: Length of the input slice.

Returns

Returns an invalid-input-index error.

pub const fn invalid_output_index(index: usize, len: usize) -> Self

Creates an invalid-output-index error.

Parameters

• index: Invalid output index supplied by the caller.
• len: Length of the output slice.

Returns

Returns an invalid-output-index error.

Trait Implementations

impl<E: Clone> Clone for CodecDecodeError<E>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<E: Copy> Copy for CodecDecodeError<E>

impl<E: Debug> Debug for CodecDecodeError<E>

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

Formats the value using the given formatter.

impl<E> Display for CodecDecodeError<E>

where E: Display,

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

Formats the value using the given formatter.

impl<E: Eq> Eq for CodecDecodeError<E>

impl<E> Error for CodecDecodeError<E>

where E: Error + 'static, Self: Debug + Display,

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<E: Hash> Hash for CodecDecodeError<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 CodecDecodeError<E>

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