Skip to main content

CodecBufferedDecoder

Struct CodecBufferedDecoder 

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

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

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

§Type Parameters

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

Implementations§

Source§

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

Source

pub const 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> BufferedDecoder<<C as Codec>::Unit, <C as Codec>::Value> for CodecBufferedDecoder<C>
where C: Codec,

Source§

impl<C> BufferedTranscoder<<C as Codec>::Unit, <C as Codec>::Value> for CodecBufferedDecoder<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 reset(&mut self)

Resets hook-owned state.

§Returns

Returns unit ().

Source§

fn transcode( &mut self, input: &[C::Unit], input_index: usize, output: &mut [C::Value], output_index: usize, ) -> Result<TranscodeProgress, 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, FinishError<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>

Error reported for semantic conversion failures.
Source§

impl<C: Clone> Clone for CodecBufferedDecoder<C>

Source§

fn clone(&self) -> CodecBufferedDecoder<C>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<C: Debug> Debug for CodecBufferedDecoder<C>

Source§

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

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

impl<C: Default> Default for CodecBufferedDecoder<C>

Source§

fn default() -> CodecBufferedDecoder<C>

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

impl<C: Eq> Eq for CodecBufferedDecoder<C>

Source§

impl<C: Hash> Hash for CodecBufferedDecoder<C>

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl<C: PartialEq> PartialEq for CodecBufferedDecoder<C>

Source§

fn eq(&self, other: &CodecBufferedDecoder<C>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<C> StructuralPartialEq for CodecBufferedDecoder<C>

Auto Trait Implementations§

§

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

§

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

§

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

§

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

§

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

§

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

§

impl<C> UnwindSafe for CodecBufferedDecoder<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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.