Enum TranscodeConvertError 

pub enum TranscodeConvertError<DE, EE, V> {
    Failure(TranscodeFailure),
    DecodeDomain(TranscodeDomainError<DE>),
    EncodeDomain(TranscodeDomainError<EE>),
    Unencodable {
        input_index: usize,
        value: Option<V>,
    },
}

Error reported by a unit-to-unit transcode conversion.

Type Parameters

• DE: Source decoder domain error.
• EE: Target encoder domain error.
• V: Owned intermediate value retained when encoding is rejected.

Examples

use qubit_codec::TranscodeConvertError;

let error = TranscodeConvertError::<&str, &str, u8>::unencodable(3, 42);
assert_eq!(error.unencodable_ref(), Some((3, Some(&42))));
assert_eq!(error.failure_ref(), None);

Variants

Failure(TranscodeFailure)

Framework-level transcode failure.

Tuple Fields

0: TranscodeFailure

Framework contract, capacity, or lifecycle failure.

DecodeDomain(TranscodeDomainError<DE>)

Source-side domain error.

Tuple Fields

0: TranscodeDomainError<DE>

Owned source error with its lifecycle phase and input context.

EncodeDomain(TranscodeDomainError<EE>)

Target-side domain error.

Tuple Fields

0: TranscodeDomainError<EE>

Owned target error with its lifecycle phase and input context.

Unencodable

The decoded intermediate value cannot be encoded by the target codec and policy.

Fields

input_index: usize

Absolute source input index of the value being encoded.

value: Option<V>

Some retains the decoded intermediate value; None means value context was unavailable or intentionally omitted.

Implementations

impl<DE, EE, V> TranscodeConvertError<DE, EE, V>

pub const fn decode_domain_reset(source: DE) -> Self

Creates a source reset-phase domain-specific converter error.

Parameters

• source: Owned source error raised during reset.

Returns

Returns a source-domain reset error.

pub const fn decode_domain_main(source: DE, input_index: usize) -> Self

Creates a source main-phase domain-specific converter error.

Parameters

• source: Owned source error raised during conversion.
• input_index: Absolute source position of the failed operation.

Returns

Returns a source-domain main-phase error at the supplied input index.

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

Creates a source main-phase converter error with decode consumption context.

Parameters

• source: Owned source error raised during conversion.
• input_index: Absolute source position of the failed operation.
• input_consumed: Some records invalid units consumed; None means unknown.

Returns

Returns a source-domain main-phase error retaining consumption context.

pub const fn decode_domain_finish(source: DE) -> Self

Creates a source finish-phase domain-specific converter error.

Parameters

• source: Owned source error raised during finalization.

Returns

Returns a source-domain finish error.

pub const fn encode_domain_reset(source: EE) -> Self

Creates a target reset-phase domain-specific converter error.

Parameters

• source: Owned target error raised during reset.

Returns

Returns a target-domain reset error.

pub const fn encode_domain_main(source: EE, input_index: usize) -> Self

Creates a target main-phase domain-specific converter error.

Parameters

• source: Owned target error raised during conversion.
• input_index: Absolute source position of the failed operation.

Returns

Returns a target-domain main-phase error at the supplied input index.

pub const fn encode_domain_finish(source: EE) -> Self

Creates a target finish-phase domain-specific converter error.

Parameters

• source: Owned target error raised during finalization.

Returns

Returns a target-domain finish error.

pub fn unencodable(input_index: usize, value: V) -> Self

Creates an unencodable intermediate-value error with value context.

Parameters

• input_index: Absolute source index of the rejected value.
• value: Intermediate value moved into the error for recovery.

Returns

Returns an unencodable error owning Some(value).

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

Creates an unencodable intermediate-value error without value context.

Parameters

• input_index: Absolute source index of the rejected value.

Returns

Returns an unencodable error with absent (None) value context.

pub fn from_encode_error_with_value( error: TranscodeEncodeError<EE, V>, fallback_value: V, ) -> Self

Converts an encode error into a converter error while adding fallback value context to unencodable errors that lack it.

Parameters

• error: Owned target-side error to convert.
• fallback_value: Value moved into absent context, or dropped if not needed.

Returns

Returns the converted error, adding the fallback only when unencodable value context is absent.

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

Returns the framework failure carried by this error.

Returns

Returns Some for a framework failure, or None for domain and unencodable errors.

pub const fn unencodable_ref(&self) -> Option<(usize, Option<&V>)>

Borrows the unencodable value context carried by this error.

Returns

Returns Some((index, value)) for an unencodable error and None otherwise. The inner Some borrows retained value context; inner None means it is absent.

pub fn map_decode_domain<F, T>(self, f: F) -> TranscodeConvertError<T, EE, V>

where F: FnOnce(DE) -> T,

Maps the source domain error while preserving other errors.

Type Parameters

• F: One-shot transformation from DE to T.
• T: Replacement payload type.

Parameters

• f: Invoked only for a source-domain error; otherwise dropped without being called.

Returns

Returns an owned error preserving all other variants and positional context.

Panics

Propagates a panic if the invoked transformation panics.

pub fn map_encode_domain<F, T>(self, f: F) -> TranscodeConvertError<DE, T, V>

where F: FnOnce(EE) -> T,

Maps the target domain error while preserving other errors.

Type Parameters

• F: One-shot transformation from EE to T.
• T: Replacement payload type.

Parameters

• f: Invoked only for a target-domain error; otherwise dropped without being called.

Returns

Returns an owned error preserving all other variants and positional context.

Panics

Propagates a panic if the invoked transformation panics.

pub fn map_value<F, W>(self, f: F) -> TranscodeConvertError<DE, EE, W>

where F: FnOnce(V) -> W,

Maps value context carried by unencodable-value errors.

Type Parameters

• F: One-shot transformation from V to W.
• W: Replacement payload type.

Parameters

• f: Invoked only for present unencodable value context; otherwise dropped without being called.

Returns

Returns an owned error preserving all other variants and positional context.

Panics

Propagates a panic if the invoked transformation panics.

Trait Implementations

impl<DE: Clone, EE: Clone, V: Clone> Clone for TranscodeConvertError<DE, EE, V>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<DE: Debug, EE: Debug, V: Debug> Debug for TranscodeConvertError<DE, EE, V>

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

Formats the value using the given formatter.

impl<DE, EE, V> Display for TranscodeConvertError<DE, EE, V>

where TranscodeDomainError<DE>: Display, TranscodeDomainError<EE>: Display,

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

Formats the value using the given formatter.

impl<DE: Eq, EE: Eq, V: Eq> Eq for TranscodeConvertError<DE, EE, V>

impl<DE, EE, V> Error for TranscodeConvertError<DE, EE, V>

where TranscodeDomainError<DE>: Error + 'static, TranscodeDomainError<EE>: 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<DE, EE, V> From<CapacityError> for TranscodeConvertError<DE, EE, V>

fn from(error: CapacityError) -> Self

Converts capacity planning errors into transcode framework errors.

Parameters

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

Returns

Returns the corresponding converter variant preserving the original cause.

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<DE, EE, V> From<TranscodeEncodeError<EE, V>> for TranscodeConvertError<DE, EE, V>

fn from(error: TranscodeEncodeError<EE, V>) -> Self

Converts a target-side encode 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<DE, EE, V> From<TranscodeFailure> for TranscodeConvertError<DE, EE, V>

fn from(source: TranscodeFailure) -> Self

Converts to this type from the input type.

impl<DE: Hash, EE: Hash, V: Hash> Hash for TranscodeConvertError<DE, EE, V>

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<DE: PartialEq, EE: PartialEq, V: PartialEq> PartialEq for TranscodeConvertError<DE, EE, V>

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

Equality operator ==.

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

Inequality operator !=.

impl<DE: PartialEq, EE: PartialEq, V: PartialEq> StructuralPartialEq for TranscodeConvertError<DE, EE, V>