Enum TranscodeError 

pub enum TranscodeError<E> {
    InvalidInputIndex {
        index: usize,
        len: usize,
    },
    InvalidOutputIndex {
        index: usize,
        len: usize,
    },
    InsufficientOutput {
        output_index: usize,
        required: usize,
        available: usize,
    },
    OutputLengthOverflow,
    Domain(E),
}

Error reported by a transcode operation.

Buffer contract failures are framework errors owned by the transcode layer and are represented directly by this enum. Codec-, charset-, or policy-specific failures are carried as domain errors.

Type Parameters

• E: Domain error reported by the concrete transcoder.

Variants

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 required output.

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.

Domain(E)

Domain-specific codec, charset, or policy error.

Implementations

impl<E> TranscodeError<E>

pub const fn domain(error: E) -> Self

Creates a domain-specific transcode error.

Parameters

• error: Domain error reported by the concrete transcoder.

Returns

Returns a transcode error wrapping error.

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

Creates an invalid-input-index error.

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

Creates an invalid-output-index error.

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

Creates an insufficient-output error.

pub const fn output_length_overflow() -> Self

Creates an output-length-overflow error.

pub const fn is_domain(&self) -> bool

Returns whether this error wraps a domain error.

Returns

Returns true for TranscodeError::Domain.

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

Borrows the wrapped domain error.

Returns

Returns Some(error) for TranscodeError::Domain and None for buffer contract errors.

pub fn map_domain<F, T>(self, f: F) -> TranscodeError<T>

where F: FnOnce(E) -> T,

Maps the wrapped domain error while preserving buffer contract errors.

Type Parameters

• F: Mapping function type.
• T: Target domain error type.

Parameters

• f: Function applied to the wrapped domain error.

Returns

Returns the mapped transcode error.

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

Validates that input_index is within an input slice.

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

Validates that output_index is within an output slice.

pub fn ensure_transcode_indices( input_len: usize, input_index: usize, output_len: usize, output_index: usize, ) -> Result<(), Self>

Validates input and output start indices for a transcode call.

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

Validates that an output slice can hold one-shot finalization output.

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

Validates an indexed output range and its minimum writable capacity.

Trait Implementations

impl<E: Clone> Clone for TranscodeError<E>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<E: Copy> Copy for TranscodeError<E>

impl<E: Debug> Debug for TranscodeError<E>

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

Formats the value using the given formatter.

impl<E> Display for TranscodeError<E>

where E: Display,

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

Formats the value using the given formatter.

impl<E: Eq> Eq for TranscodeError<E>

impl<E> Error for TranscodeError<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> From<CapacityError> for TranscodeError<E>

fn from(error: CapacityError) -> Self

Converts capacity planning errors into transcode framework errors.

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

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