Struct DecoderImpl 

pub struct DecoderImpl<R, C: Config, Context, const UNTRUSTED: bool = false> { /* private fields */ }

A Decoder that reads bytes from a given reader R.

This struct should rarely be used. In most cases, prefer any of the decode functions.

Use Self::new_untrusted to construct a decoder accepted by the explicit untrusted traits. Allocation behavior belongs to the trait being called: Decode retains ordinary behavior even on this decoder; call super::DecodeUntrusted::decode_untrusted for collection safeguards.

The ByteOrder that is chosen will impact the endianness that is used to read integers out of the reader.

use bincode::de::{DecoderImpl, Decode};
let mut context = ();
let mut decoder = DecoderImpl::new(some_reader, bincode::config::standard(), &mut context);
// this u32 can be any Decode
let value = u32::decode(&mut decoder).unwrap();

Implementations

impl<R: Reader, C: Config, Context> DecoderImpl<R, C, Context>

pub fn new(reader: R, config: C, context: Context) -> DecoderImpl<R, C, Context>

Construct a new Decoder

pub fn new_untrusted( reader: R, config: C, context: Context, ) -> DecoderImpl<R, C, Context, true>

Construct a decoder accepted by super::DecodeUntrusted.

Call the untrusted traits to use their collection safeguards. The capability is preserved by Decoder::with_context and mutable references.

Trait Implementations

impl<'de, R: BorrowReader<'de>, C: Config, Context, const UNTRUSTED: bool> BorrowDecoder<'de> for DecoderImpl<R, C, Context, UNTRUSTED>

type BR = R

The concrete BorrowReader type

fn borrow_reader(&mut self) -> &mut Self::BR

Rerturns a mutable reference to the borrow reader

impl<R: Reader, C: Config, Context, const UNTRUSTED: bool> Decoder for DecoderImpl<R, C, Context, UNTRUSTED>

type R = R

The concrete Reader type

type C = C

The concrete Config type

type Context = Context

The decoding context type

fn reader(&mut self) -> &mut Self::R

Returns a mutable reference to the reader

fn config(&self) -> &Self::C

Returns a reference to the config

fn claim_bytes_read(&mut self, n: usize) -> Result<(), DecodeError>

Claim that n bytes are going to be read from the decoder. This can be used to validate Configuration::Limit<N>().

fn unclaim_bytes_read(&mut self, n: usize)

Notify the decoder that n bytes are being reclaimed.

fn context(&mut self) -> &mut Self::Context

Returns the decoding context

fn with_context<C>(&mut self, context: C) -> WithContext<'_, Self, C>

Wraps decoder with a context

fn claim_container_read<T>(&mut self, len: usize) -> Result<(), DecodeError>

Claim that we’re going to read a container which contains len entries of T. This will correctly handle overflowing if len * size_of::<T>() > usize::max_value

impl<R: Reader, C: Config, Context> UntrustedDecoder for DecoderImpl<R, C, Context, true>