Enum TranscodeDomainError 

pub enum TranscodeDomainError<E> {
    Reset {
        source: E,
    },
    Main {
        source: E,
        input_index: usize,
        input_consumed: Option<NonZeroUsize>,
    },
    Finish {
        source: E,
    },
}

Domain-specific codec, charset, or policy error with transcode context.

Reset and finish failures are lifecycle failures and therefore cannot carry an input index. Main-phase failures always carry the absolute input index where the domain error occurred.

Type Parameters

• E: Domain error reported by the concrete codec, hook, or facade.

Examples

use qubit_codec::TranscodeDomainError;

let error = TranscodeDomainError::main("invalid byte", 4);
assert_eq!(error.input_index(), Some(4));
assert_eq!(error.to_string(), "codec main error at input index 4: invalid byte");

Variants

Reset

Domain error reported while resetting codec or hook state.

Fields

source: E

Domain error returned by the codec or policy facade.

Main

Domain error reported while processing input.

Fields

source: E

Domain error returned by the codec or policy facade.

input_index: usize

Absolute input index where the error occurred.

input_consumed: Option<NonZeroUsize>

Invalid input units consumed by the codec-domain error, when known.

Finish

Domain error reported while finishing codec or hook state.

Fields

source: E

Domain error returned by the codec or policy facade.

Implementations

impl<E> TranscodeDomainError<E>

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

Creates a reset-phase domain error.

Parameters

• source: Domain error returned by reset handling.

Returns

Returns a reset-phase domain error.

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

Creates a main-phase domain error.

Parameters

• source: Domain error returned by value processing.
• input_index: Absolute input index where the error occurred.

Returns

Returns a main-phase domain error.

pub const fn main_with_consumed( source: E, input_index: usize, input_consumed: Option<NonZeroUsize>, ) -> Self

Creates a main-phase domain error with decode consumption context.

Parameters

• source: Domain error returned by value processing.
• input_index: Absolute input index where the error occurred.
• input_consumed: Invalid input units consumed, when known.

Returns

Returns a main-phase domain error with consumption context.

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

Creates a finish-phase domain error.

Parameters

• source: Domain error returned by finish handling.

Returns

Returns a finish-phase domain error.

pub const fn source(&self) -> &E

Returns the wrapped source error.

Returns

Returns a shared reference to the domain error.

pub fn into_source(self) -> E

Consumes this error and returns the wrapped source error.

Returns

Returns the domain error.

pub const fn input_index(&self) -> Option<usize>

Returns the absolute input index associated with the error.

Returns

Returns Some(index) for main-phase errors and None for reset or finish errors.

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

Returns invalid input consumption associated with the error.

Returns

Returns Some(consumed) when a main-phase decode error reports the invalid input width. Returns None otherwise.

pub fn map_source<T, F>(self, f: F) -> TranscodeDomainError<T>

where F: FnOnce(E) -> T,

Maps the wrapped source error while preserving phase context.

Type Parameters

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

Parameters

• f: Function applied to the wrapped source error.

Returns

Returns the mapped domain error.

Trait Implementations

impl<E: Clone> Clone for TranscodeDomainError<E>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<E: Copy> Copy for TranscodeDomainError<E>

impl<E: Debug> Debug for TranscodeDomainError<E>

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

Formats the value using the given formatter.

impl<E> Display for TranscodeDomainError<E>

where E: Display,

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

Formats the value using the given formatter.

impl<E: Eq> Eq for TranscodeDomainError<E>

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

fn from(source: TranscodeDomainError<E>) -> Self

Converts to this type from the input type.

impl<E, V> From<TranscodeDomainError<E>> for TranscodeEncodeError<E, V>

fn from(source: TranscodeDomainError<E>) -> Self

Converts to this type from the input type.

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

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<E: PartialEq> StructuralPartialEq for TranscodeDomainError<E>