Struct bytecodec::bytes::BytesDecoder

pub struct BytesDecoder<B> { /* fields omitted */ }

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, DecodeBuf};
use bytecodec::bytes::BytesDecoder;

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

let mut input = DecodeBuf::new(b"foobar");
let item = decoder.decode(&mut input).unwrap();
assert_eq!(item.as_ref(), Some(b"foo"));
assert_eq!(decoder.requiring_bytes_hint(), Some(0)); // no more items are decoded

Methods

impl<B> BytesDecoder<B>

pub fn new(bytes: B) -> Self

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

Trait Implementations

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

fn fmt(&self, __arg_0: &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: &mut DecodeBuf) -> Result<Option<Self::Item>>

Consumes the given buffer (a part of a byte sequence), and decodes an item from it.

fn has_terminated(&self) -> bool

Returns true if the decoder cannot decode items anymore, otherwise false.

fn is_idle(&self) -> bool

Returns true if the decoder does not have an item that being decoded, otherwise false.

fn requiring_bytes_hint(&self) -> Option<u64>

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