Struct BytesDecoder

pub struct BytesDecoder<B = Vec<u8>> { /* private fields */ }

BytesDecoder copies bytes from an input sequence to a slice.

This is a oneshot decoder (i.e., it decodes only one item).

Examples

use bytecodec::Decode;
use bytecodec::bytes::BytesDecoder;
use bytecodec::io::IoDecodeExt;

let mut decoder = BytesDecoder::new([0; 3]);
assert_eq!(decoder.requiring_bytes().to_u64(), Some(3));

let item = decoder.decode_exact(b"foobar".as_ref()).unwrap();
assert_eq!(item.as_ref(), b"foo");
assert_eq!(decoder.requiring_bytes().to_u64(), Some(0)); // no more items are decoded

Implementations

impl<B: AsRef<[u8]> + AsMut<[u8]>> BytesDecoder<B>

pub fn new(bytes: B) -> Self

Makes a new BytesDecoder instance for filling the given byte slice.

pub fn set_bytes(&mut self, bytes: B)

Sets the byte slice to be filled.

Trait Implementations

impl<B: Debug> Debug for BytesDecoder<B>

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

Formats the value using the given formatter.

impl<B: AsRef<[u8]> + AsMut<[u8]>> Decode for BytesDecoder<B>

type Item = B

The type of items to be decoded.

fn decode(&mut self, buf: &[u8], eos: Eos) -> Result<usize>

Consumes the given buffer (a part of a byte sequence), and proceeds the decoding process.

fn finish_decoding(&mut self) -> Result<Self::Item>

Finishes the current decoding process and returns the decoded item.

fn requiring_bytes(&self) -> ByteCount

Returns the lower bound of the number of bytes needed to decode the next item.

fn is_idle(&self) -> bool

Returns true if there are no items to be decoded by the decoder at the next invocation of decode method, otherwise false.

impl<B> Default for BytesDecoder<B>

fn default() -> Self

Returns the “default value” for a type.