Struct CodecTranscodeConverter 

pub struct CodecTranscodeConverter<D, E>
where
    D: Codec,
    E: Codec<Value = D::Value>,
{ /* private fields */ }

Converts source units to target units through a decoded value by using codecs.

The converter decodes one source value with the decoder codec, then encodes that value with the encoder codec. If the current output buffer cannot hold the encoded value, the already decoded value is retained by the common converter engine and must be drained before more source input is consumed. Incomplete source tails are left in the caller-provided input slice; callers own input-buffer refill and EOF incomplete-tail policy.

Type Parameters

• D: Low-level codec used to decode source units.
• E: Low-level codec used to encode target units.

Implementations

impl<D, E> CodecTranscodeConverter<D, E>

where D: Codec, E: Codec<Value = D::Value>,

pub fn new(decoder: D, encoder: E) -> Self

Creates a buffered converter backed by decoder and encoder codecs.

Parameters

• decoder: Low-level codec used to decode source units.
• encoder: Low-level codec used to encode target units.

Returns

Returns a buffered converter adapter for the supplied codecs.

pub fn max_output_len(&self, input_len: usize) -> Result<usize, CapacityError>

Returns an upper bound for target units produced from input_len units.

This concrete adapter method is available even when D::Value does not implement Default.

Parameters

• input_len: Source units the caller plans to convert.

Returns

Returns a conservative upper bound for produced target units.

pub fn max_finish_output_len(&self) -> Result<usize, CapacityError>

Returns the maximum target units emitted by finishing internal state.

Returns

Returns a conservative upper bound for remaining converter-final output.

pub fn max_reset_output_len(&self) -> Result<usize, CapacityError>

Returns the maximum target units emitted when resetting stream state.

pub fn reset( &mut self, output: &mut [E::Unit], output_index: usize, ) -> Result<usize, TranscodeError<CodecConvertError<<D as Codec>::DecodeError, <E as Codec>::EncodeError>>>

Clears retained pending output and hook state and emits stream-start encode output.

pub fn transcode( &mut self, input: &[D::Unit], input_index: usize, output: &mut [E::Unit], output_index: usize, ) -> Result<TranscodeProgress, TranscodeError<CodecConvertError<<D as Codec>::DecodeError, <E as Codec>::EncodeError>>>

Converts source units into target units.

This is the main streaming operation and does not require D::Value to implement Default.

Parameters

• input: Source unit slice.
• input_index: Absolute source index where conversion starts.
• output: Target unit slice.
• output_index: Absolute target index where writing starts.

Returns

Returns conversion progress for consumed/produced counters and stop reason.

Errors

Returns converter error when source or target indices are invalid, or when decoding/encoding fails under current policy.

pub fn finish( &mut self, output: &mut [E::Unit], output_index: usize, ) -> Result<usize, TranscodeError<CodecConvertError<<D as Codec>::DecodeError, <E as Codec>::EncodeError>>>

Finishes internally retained output after EOF.

Finalization delegates to the reusable converter engine. It drains retained pending output, encodes source-side decode flush values, and then finishes target-side encode hook state.

Parameters

• output: Target unit slice for finalization output.
• output_index: Absolute target output index where writing starts.

Returns

Returns the number of target units written by finalization.

Errors

Returns a finish error for pending output that cannot be finalized.

Trait Implementations

impl<D, E> Clone for CodecTranscodeConverter<D, E>

where D: Codec, E: Codec<Value = D::Value>, TranscodeConvertEngine<D, E, CodecTranscodeConvertHooks>: Clone,

fn clone(&self) -> Self

Clones the wrapped converter engine.

Returns

Returns a cloned converter adapter sharing the same inner engine state.

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

Performs copy-assignment from source.

impl<D, E> Debug for CodecTranscodeConverter<D, E>

where D: Codec, E: Codec<Value = D::Value>, TranscodeConvertEngine<D, E, CodecTranscodeConvertHooks>: Debug,

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

Formats the wrapped converter engine for debugging.

Parameters

• f: Destination formatter.

Returns

Returns fmt::Result from the formatter.

impl<D, E> Default for CodecTranscodeConverter<D, E>

where D: Codec, E: Codec<Value = D::Value>, TranscodeConvertEngine<D, E, CodecTranscodeConvertHooks>: Default,

fn default() -> Self

Creates a default codec-backed buffered converter.

Returns

Returns a converter with default codecs and hooks.

impl<D, E> Eq for CodecTranscodeConverter<D, E>

where D: Codec, E: Codec<Value = D::Value>, TranscodeConvertEngine<D, E, CodecTranscodeConvertHooks>: Eq,

impl<D, E> Hash for CodecTranscodeConverter<D, E>

where D: Codec, E: Codec<Value = D::Value>, TranscodeConvertEngine<D, E, CodecTranscodeConvertHooks>: Hash,

fn hash<S: Hasher>(&self, state: &mut S)

Hashes the wrapped converter engine.

Parameters

• state: Output hash state.

Returns

Returns unit ().

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<D, E> PartialEq for CodecTranscodeConverter<D, E>

where D: Codec, E: Codec<Value = D::Value>, TranscodeConvertEngine<D, E, CodecTranscodeConvertHooks>: PartialEq,

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

Compares the wrapped converter engine.

Parameters

• other: Another converter to compare with.

Returns

Returns true when the wrapped engines are equal.

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<D, E> TranscodeConverter<<D as Codec>::Unit, <E as Codec>::Unit> for CodecTranscodeConverter<D, E>

where D: Codec, E: Codec<Value = D::Value>,

impl<D, E> Transcoder<<D as Codec>::Unit, <E as Codec>::Unit> for CodecTranscodeConverter<D, E>

where D: Codec, E: Codec<Value = D::Value>,

fn max_output_len(&self, input_len: usize) -> Result<usize, CapacityError>

Returns an upper bound for target units produced from input_len units.

Parameters

• input_len: Source units the caller plans to convert.

Returns

Returns a conservative upper bound for produced target units.

fn max_finish_output_len(&self) -> Result<usize, CapacityError>

Returns the maximum target units emitted by finishing internal state.

Returns

Returns a conservative upper bound for remaining converter-final output.

fn max_reset_output_len(&self) -> Result<usize, CapacityError>

Returns the maximum target units emitted when resetting stream state.

fn reset( &mut self, output: &mut [E::Unit], output_index: usize, ) -> Result<usize, TranscodeError<Self::Error>>

Clears retained pending output, resets component state, and emits stream-start encode output.

fn transcode( &mut self, input: &[D::Unit], input_index: usize, output: &mut [E::Unit], output_index: usize, ) -> Result<TranscodeProgress, TranscodeError<Self::Error>>

Converts source units into target units.

Parameters

• input: Source unit slice.
• input_index: Absolute source index where conversion starts.
• output: Target unit slice.
• output_index: Absolute target index where writing starts.

Returns

Returns conversion progress for consumed/produced counters and stop reason.

Errors

Returns converter error when source or target indices are invalid, or when decoding/encoding fails under current policy.

fn finish( &mut self, output: &mut [E::Unit], output_index: usize, ) -> Result<usize, TranscodeError<Self::Error>>

Finishes internally retained output after EOF.

Parameters

• output: Target unit slice for finalization output.
• output_index: Absolute target output index where writing starts.

Returns

Returns the number of target units written by finalization.

Errors

Returns a finish error for pending output that cannot be finalized.

type Error = CodecConvertError<<D as Codec>::DecodeError, <E as Codec>::EncodeError>

Domain error reported by semantic conversion failures.