Skip to main content

CodecValueDecoder

Struct CodecValueDecoder 

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

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. Successfully decoded prefixes followed by extra units are reported as trailing input.

§Type Parameters

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

Implementations§

Source§

impl<C> CodecValueDecoder<C>

Source

pub const 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.

Trait Implementations§

Source§

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

Source§

fn clone(&self) -> CodecValueDecoder<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: Copy> Copy for CodecValueDecoder<C>

Source§

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

Source§

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

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

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

Source§

fn default() -> CodecValueDecoder<C>

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

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

Source§

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

Source§

fn eq(&self, other: &CodecValueDecoder<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 CodecValueDecoder<C>

Source§

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

Source§

fn decode(&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.

Source§

type Output = <C as Codec>::Value

Decoded output type.
Source§

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

Decoding error type.

Auto Trait Implementations§

§

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

§

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

§

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

§

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

§

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

§

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

§

impl<C> UnwindSafe for CodecValueDecoder<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.