Enum CodecEncodeError 

pub enum CodecEncodeError<E> {
    Encode {
        source: E,
        input_index: usize,
    },
    UnencodableValue {
        input_index: usize,
    },
    InvalidInputIndex {
        index: usize,
        len: usize,
    },
    InvalidOutputIndex {
        index: usize,
        len: usize,
    },
    InsufficientOutput {
        output_index: usize,
        required: usize,
        available: usize,
    },
    OutputLengthOverflow,
}

Error reported by codec-backed buffered encoder adapters.

The wrapped codec remains responsible for domain-specific encode failures. This type adds adapter-level failures that cannot be represented by the wrapped codec itself, such as a buffered encoder receiving an invalid input or output start index.

Variants

Encode

The wrapped codec reported an encode error.

Fields

source: E

Error returned by the wrapped codec.

input_index: usize

Absolute input index of the value being encoded.

UnencodableValue

The wrapped codec cannot represent the input value.

Fields

input_index: usize

Absolute input index of the value being encoded.

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.

InsufficientOutput

The output slice cannot hold all output required by the adapter call.

Fields

output_index: usize

Absolute output index where writing would start.

required: usize

Output units required from output_index.

available: usize

Output units available from output_index.

OutputLengthOverflow

Output length arithmetic overflowed while planning encoded output.

Implementations

impl<E> CodecEncodeError<E>

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

Creates an error wrapping a codec-specific encode error.

Parameters

• source: Error returned by the wrapped codec.
• input_index: Absolute input index of the value being encoded.

Returns

Returns a codec encode error wrapper.

pub const fn unencodable_value(input_index: usize) -> Self

Creates an unencodable-value error.

Parameters

• input_index: Absolute input index of the value being encoded.

Returns

Returns an unencodable-value 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.

pub const fn insufficient_output( output_index: usize, required: usize, available: usize, ) -> Self

Creates an insufficient-output error.

Parameters

• output_index: Output index supplied by the caller.
• required: Output units required from output_index.
• available: Output units available from output_index.

Returns

Returns an insufficient-output error.

pub const fn output_length_overflow() -> Self

Creates an output-length-overflow error.

Returns

Returns an output-length-overflow error.

pub fn ensure_input_index( input_len: usize, input_index: usize, ) -> Result<(), Self>

Validates that input_index is within an input slice.

Parameters

• input_len: Length of the input slice.
• input_index: Input index supplied by the caller.

Returns

Returns Ok(()) when input_index <= input_len.

Errors

Returns an invalid-input-index error when input_index is beyond the slice.

pub fn ensure_output_index( output_len: usize, output_index: usize, ) -> Result<(), Self>

Validates that output_index is within an output slice.

Parameters

• output_len: Length of the output slice.
• output_index: Output index supplied by the caller.

Returns

Returns Ok(()) when output_index <= output_len.

Errors

Returns an invalid-output-index error when output_index is beyond the slice.

pub fn ensure_output_capacity( output_len: usize, output_index: usize, required: usize, ) -> Result<(), Self>

Validates that an output slice can hold required adapter output.

Parameters

• output_len: Length of the output slice.
• output_index: Output index supplied by the caller.
• required: Output units required from output_index.

Returns

Returns Ok(()) when output capacity is sufficient.

Errors

Returns an invalid-output-index error when output_index is beyond the slice, or an insufficient-output error when fewer than required units are writable from output_index.

Trait Implementations

impl<E: Clone> Clone for CodecEncodeError<E>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<E: Copy> Copy for CodecEncodeError<E>

impl<E: Debug> Debug for CodecEncodeError<E>

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

Formats the value using the given formatter.

impl<E> Display for CodecEncodeError<E>

where E: Display,

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

Formats the value using the given formatter.

impl<E: Eq> Eq for CodecEncodeError<E>

impl<E> Error for CodecEncodeError<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 CodecEncodeError<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 CodecEncodeError<E>

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