Skip to main content

CodecTranscodeDecoder

Struct CodecTranscodeDecoder 

Source
pub struct CodecTranscodeDecoder<C> { /* private fields */ }
Expand description

Decodes encoded units into caller-provided value buffers by using a Codec.

CodecTranscodeDecoder is a policy-free bridge from the low-level unchecked Codec contract to Transcoder and TranscodeDecoder. It leaves incomplete input tails in the caller-provided input slice; callers own input-buffer refill and EOF incomplete-tail policy.

Because Transcoder::finish receives no source input, this adapter is intended for codecs whose decode boundary is locally decidable from the visible prefix plus codec state. Formats that require EOF-aware maximal-munch parsing or need to reinterpret a pending prefix at EOF should provide a custom streaming decoder or a value-level facade.

§Type Parameters

  • C: Low-level codec used to decode values.

Implementations§

Source§

impl<C> CodecTranscodeDecoder<C>
where C: Codec,

Source

pub fn new(codec: C) -> Self

Creates a buffered decoder backed by codec.

§Parameters
  • codec: Low-level codec used to decode values.
§Returns

Returns a buffered decoder adapter for the supplied codec.

Trait Implementations§

Source§

impl<C: Debug> Debug for CodecTranscodeDecoder<C>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<C: Default> Default for CodecTranscodeDecoder<C>

Source§

fn default() -> CodecTranscodeDecoder<C>

Returns the “default value” for a type. Read more
Source§

impl<C> TranscodeDecoder<<C as Codec>::Unit, <C as Codec>::Value> for CodecTranscodeDecoder<C>
where C: Codec,

Source§

impl<C> Transcoder<<C as Codec>::Unit, <C as Codec>::Value> for CodecTranscodeDecoder<C>
where C: Codec,

Source§

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

Returns an upper bound for decoded values produced from input_len units.

§Parameters
  • input_len: Source units the caller plans to decode.
§Returns

Returns a conservative upper bound for decoded values.

Source§

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

Returns the maximum values emitted by finishing internal state.

§Returns

Returns the number of values that may still be emitted by finishing state.

Source§

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

Returns the maximum values emitted when resetting internal state.

Source§

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

Runs before-reset cleanup for decoder state.

Source§

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

Decodes source units into logical values.

§Parameters
  • input: Source unit slice.
  • input_index: Absolute source index where decoding starts.
  • output: Destination value slice.
  • output_index: Absolute output value index where writing starts.
§Returns

Returns conversion progress for consumed and written counters.

§Errors

Returns a decode error when indices are invalid or when conversion fails under hook policy.

Source§

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

Finishes internally retained output after EOF.

§Parameters
  • output: Destination value slice for final retained values.
  • output_index: Absolute output value index where writing starts.
§Returns

Returns the number of values written by finalization.

§Errors

Returns a finish error if finalization cannot complete.

Source§

type Error = CodecDecodeError<<C as Codec>::DecodeError>

Domain error reported by semantic conversion failures.

Auto Trait Implementations§

§

impl<C> Freeze for CodecTranscodeDecoder<C>
where C: Freeze,

§

impl<C> RefUnwindSafe for CodecTranscodeDecoder<C>
where C: RefUnwindSafe,

§

impl<C> Send for CodecTranscodeDecoder<C>
where C: Send,

§

impl<C> Sync for CodecTranscodeDecoder<C>
where C: Sync,

§

impl<C> Unpin for CodecTranscodeDecoder<C>
where C: Unpin,

§

impl<C> UnsafeUnpin for CodecTranscodeDecoder<C>
where C: UnsafeUnpin,

§

impl<C> UnwindSafe for CodecTranscodeDecoder<C>
where C: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.