Struct CodecValueDecoder 

pub struct CodecValueDecoder<C>
where
    C: Codec,
{ /* private fields */ }

Decodes one encoded unit slice into one owned value by using a Codec.

CodecValueDecoder is the default bridge from the low-level unchecked Codec contract to the convenience-layer ValueDecoder contract. The supplied input slice must contain exactly one encoded value. After a successful decode, the adapter calls Codec::decode_flush to reset decode-side stream state for the next call.

Type Parameters

• C: Low-level codec used to decode one value.

Implementations

impl<C> CodecValueDecoder<C>

where C: Codec,

pub fn new(codec: C) -> Self

Creates a decoder backed by codec.

Parameters

• codec: Low-level codec used to decode one value.

Returns

Returns a value decoder adapter for the supplied codec.

Panics

In debug builds, panics when the supplied codec violates the Codec::MIN_UNITS_PER_VALUE / Codec::MAX_UNITS_PER_VALUE ordering invariant. Release builds skip this check because the invariant is the responsibility of the Codec implementation.

Trait Implementations

impl<C> Debug for CodecValueDecoder<C>

where C: Codec + Debug,

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

Formats the decoder without requiring flushed values to be printable.

impl<C> Default for CodecValueDecoder<C>

where C: Codec + Default,

fn default() -> Self

Creates a decoder from the default codec.

impl<C> ValueDecoder<[<C as Codec>::Unit]> for CodecValueDecoder<C>

where C: Codec, C::Value: Default,

fn decode(&mut self, input: &[C::Unit]) -> Result<Self::Output, Self::Error>

Decodes exactly one encoded value from input.

Parameters

• input: Encoded units for exactly one value.

Returns

Returns the decoded value.

Errors

Returns CodecDecodeError::Incomplete when fewer than Codec::MIN_UNITS_PER_VALUE units are available. Returns CodecDecodeError::Decode when the wrapped codec rejects the input. Returns CodecDecodeError::TrailingInput when a value is decoded but extra input remains.

Panics

Panics when the wrapped codec reports a consumed unit count larger than the input slice length, or when flush output exceeds Codec::MAX_DECODE_FLUSH_VALUES.

type Output = <C as Codec>::Value

Decoded output type.

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

Decoding error type.