Struct bytecodec::combinator::Buffered

pub struct Buffered<D: Decode> { /* fields omitted */ }

Combinator that gives a buffer to the decoder.

Thsi is created by calling DecodeExt::buffer method.

Methods

impl<D: Decode> Buffered<D>

pub fn has_item(&self) -> bool

Returns true if the decoder has a decoded item, other false.

Note that the decoder cannot decode new items if this method returns true.

pub fn get_item(&self) -> Option<&D::Item>

Returns a reference to the item decoded by the decoder in the last decode call.

pub fn take_item(&mut self) -> Option<D::Item>

Takes the item decoded by the decoder in the last decode call.

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn inner_ref(&self) -> &D

Returns a reference to the inner decoder.

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn inner_mut(&mut self) -> &mut D

Returns a mutable reference to the inner decoder.

pub fn into_inner(self) -> D

Takes ownership of this instance and returns the inner decoder.

Trait Implementations

impl<D: Decode + Debug> Debug for Buffered<D>

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

Formats the value using the given formatter.

impl<D: Decode + Default> Default for Buffered<D>

fn default() -> Self

Returns the "default value" for a type.

impl<D: Decode> Decode for Buffered<D>

type Item = D::Item

The type of items to be decoded.

fn decode(
    &mut self,
    buf: &[u8],
    eos: Eos
) -> Result<(usize, 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 requiring_bytes(&self) -> ByteCount

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