Enum TranscodeError

Source

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),
}

Expand description

Error reported by a transcode operation.

The enum keeps caller-contract failures in the framework layer and stores codec-, charset-, or policy-specific failures in TranscodeError::Domain.

§Type Parameters

E: Domain error reported by the concrete transcoder.

Variants§

§

InvalidInputIndex

The caller supplied an input index beyond the input slice length.

Fields

§index: usize

Invalid input index supplied by the caller.

§len: usize

Length of the input slice.

§

InvalidOutputIndex

The caller supplied an output index beyond the output slice length.

Fields

§index: usize

Invalid output index supplied by the caller.

§len: usize

Length of the output slice.

§

InsufficientOutput

The output slice cannot hold required one-shot reset or finish output.

Fields

§output_index: usize

Output index supplied by the caller.

§required: usize

Required writable output units.

§available: usize

Available writable output units.

§

OutputLengthOverflow

Output length arithmetic overflowed.

§

Domain(E)

Domain-specific codec, charset, or policy error.

Implementations§

Source §

impl<E> TranscodeError<E>

Source

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.

Source

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 the invalid-input-index error.

Source

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 the invalid-output-index error.

Source

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 to finish in one call.
available: Output units available from output_index.

§Returns

Returns the insufficient-output error.

Source

pub const fn is_domain(&self) -> bool

Returns whether this error wraps a domain error.

§Returns

Returns true for TranscodeError::Domain.

Source

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

Borrows the wrapped domain error.

§Returns

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

Source

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

Maps the wrapped domain error while preserving framework 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.

Source

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.

Source

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.

Source

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.

§Parameters

input_len: Length of the input slice.
input_index: Input index supplied by the caller.
output_len: Length of the output slice.
output_index: Output index supplied by the caller.

§Returns

Returns Ok(()) when both indices are within their slices.

§Errors

Returns an invalid-input-index or invalid-output-index error when either index is beyond its slice.

Source

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.

§Parameters

output_len: Length of the output slice.
output_index: Output index supplied by the caller.
required: Output units required to finish in one call.

§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.

Source

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.

§Parameters

output_len: Length of the output slice.
output_index: Output index supplied by the caller.
range_len: Length of the writable range starting at output_index.
required: Minimum output units required inside the range.

§Returns

Returns Ok(()) when the range fits inside the slice and can hold required units.

§Errors

Returns an invalid-output-index error when the range overflows or extends beyond the slice, or an insufficient-output error when range_len is smaller than required.