Enum TranscodeDecodeError 

pub enum TranscodeDecodeError<E> {
    Failure(TranscodeFailure),
    Domain(TranscodeDomainError<E>),
}

Error reported by a decode-oriented transcode operation.

Type Parameters

• E: Owned codec or policy failure preserved with transcode context.

Examples

use qubit_codec::TranscodeDecodeError;

let error = TranscodeDecodeError::domain_main("invalid byte", 3);
assert!(error.is_domain());
assert_eq!(error.domain_ref(), Some(&"invalid byte"));
assert!(error.failure_ref().is_none());

Variants

Failure(TranscodeFailure)

Framework-level transcode failure.

Tuple Fields

0: TranscodeFailure

Framework contract, capacity, or incomplete-input failure.

Domain(TranscodeDomainError<E>)

Domain-specific codec, charset, or policy error.

Tuple Fields

0: TranscodeDomainError<E>

Codec failure retaining its phase and source position.

Implementations

impl<E> TranscodeDecodeError<E>

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

Creates a reset-phase domain-specific transcode error.

Parameters

• source: Owned codec or policy failure.

Returns

The domain failure tagged as reset.

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

Creates a main-phase domain-specific transcode error.

Parameters

• source: Owned codec or policy failure.
• input_index: Absolute position of the failing input.

Returns

The domain failure tagged with its main-phase input position.

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

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

Parameters

• source: Owned codec or policy failure.
• input_index: Absolute position of the failing input.
• input_consumed: Some(non-zero span) when known, or None for an unknown span.

Returns

The main-phase failure retaining the known or unknown consumed span.

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

Creates a finish-phase domain-specific transcode error.

Parameters

• source: Owned codec or policy failure.

Returns

The domain failure tagged as finish.

pub fn from_decode_failure( failure: DecodeFailure<E>, input_index: usize, available: usize, ) -> Self

Converts a low-level decode failure into a decode transcode error.

Parameters

• failure: Owned incomplete or invalid low-level failure.
• input_index: Absolute failing input position.
• available: Number of readable units at that position.

Returns

A domain error when a codec source exists; otherwise an incomplete-input framework failure.

pub const fn is_domain(&self) -> bool

Returns whether this error wraps a domain error.

Returns

True for Domain and false for a framework Failure.

pub const fn failure_ref(&self) -> Option<&TranscodeFailure>

Returns the framework failure carried by this error.

Returns

Some(borrowed failure) for Failure, or None for Domain.

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

Borrows the wrapped domain error and transcode context.

Returns

Some(borrowed context) for Domain, or None for Failure.

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

Borrows the wrapped domain error.

Returns

Some(borrowed source) for Domain, or None for Failure.

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

where F: FnOnce(E) -> T,

Maps the wrapped domain error while preserving framework failures.

Type Parameters

• F: One-shot mapping closure, invoked only for a domain failure.
• T: Replacement domain error type.

Parameters

• f: Consumes the domain source, if present; may perform caller-defined side effects. Framework failures do not invoke it.

Returns

The mapped error retaining phase and input context, or the original framework failure unchanged.

Trait Implementations

impl<E: Clone> Clone for TranscodeDecodeError<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: Debug> Debug for TranscodeDecodeError<E>

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

Formats the value using the given formatter.

impl<E> Display for TranscodeDecodeError<E>

where TranscodeDomainError<E>: Display,

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

Formats the value using the given formatter.

impl<E: Eq> Eq for TranscodeDecodeError<E>

impl<E> Error for TranscodeDecodeError<E>

where TranscodeDomainError<E>: Error, 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 TranscodeDecodeError<E>

fn from(error: CapacityError) -> Self

Converts capacity planning errors into transcode framework errors.

Parameters

• error: Owned capacity planning failure.

Returns

The corresponding framework failure wrapped in this decode error.

impl<DE, EE, V> From<TranscodeDecodeError<DE>> for TranscodeConvertError<DE, EE, V>

fn from(error: TranscodeDecodeError<DE>) -> Self

Converts a source-side decode error into a converter error.

Parameters

• error: Owned failure to convert without discarding its context.

Returns

Returns the corresponding converter variant preserving the original cause.

impl<E> From<TranscodeDomainError<E>> for TranscodeDecodeError<E>

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

Converts to this type from the input type.

impl<E> From<TranscodeFailure> for TranscodeDecodeError<E>

fn from(source: TranscodeFailure) -> Self

Converts to this type from the input type.

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

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

Equality operator ==.

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

Inequality operator !=.

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