Struct bytecodec::bytes::RemainingBytesDecoder

pub struct RemainingBytesDecoder(_);

RemainingBytesDecoder reads all the bytes from a input sequence until it reaches EOS.

Examples

use bytecodec::{Decode, DecodeBuf};
use bytecodec::bytes::RemainingBytesDecoder;

let mut decoder = RemainingBytesDecoder::new();
assert_eq!(decoder.requiring_bytes_hint(), None);

let mut input = DecodeBuf::new(b"foo");
let item = decoder.decode(&mut input).unwrap();
assert_eq!(item, None);
assert!(input.is_empty());
assert!(!input.is_eos());

let mut input = DecodeBuf::with_remaining_bytes(b"bar", 0);
let item = decoder.decode(&mut input).unwrap();
assert_eq!(item, Some(b"foobar".to_vec()));
assert!(input.is_empty());
assert!(input.is_eos());

Methods

impl RemainingBytesDecoder

pub fn new() -> Self

Makes a new RemainingBytesDecoder instance.

Trait Implementations

impl Debug for RemainingBytesDecoder

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Default for RemainingBytesDecoder

fn default() -> RemainingBytesDecoder

Returns the "default value" for a type.

impl Decode for RemainingBytesDecoder

type Item = Vec<u8>

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.