Struct CodecValueDecoder 

pub struct CodecValueDecoder<C> { /* 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

Panics when the supplied codec violates the Codec::min_units_per_value / Codec::max_units_per_value ordering invariant. Validating once at construction lets the hot decode path skip the check.

Trait Implementations

impl<C: Clone> Clone for CodecValueDecoder<C>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<C: Copy> Copy for CodecValueDecoder<C>

impl<C: Debug> Debug for CodecValueDecoder<C>

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

Formats the value using the given formatter.

impl<C: Default> Default for CodecValueDecoder<C>

fn default() -> CodecValueDecoder<C>

Returns the “default value” for a type.

impl<C: Eq> Eq for CodecValueDecoder<C>

impl<C: Hash> Hash for CodecValueDecoder<C>

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<C: PartialEq> PartialEq for CodecValueDecoder<C>

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

Tests for self and other values to be equal, and is used by ==.

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<C: PartialEq> StructuralPartialEq for CodecValueDecoder<C>

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

where C: Codec,

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 = CodecDecodeError<<C as Codec>::DecodeError>

Decoding error type.