Struct bytecodec::combinator::Peekable

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

Combinator that enables to peek decoded items before calling finish_decoding method.

This is created by calling DecodeExt::peekable method.

Methods

impl<D: Decode> Peekable<D>

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

Returns a reference to the last item decoded (but not finish_decoding called yet) by the decoder.

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

Returns a mutable reference to the last item decoded (but not finish_decoding called yet) by the decoder.

Important traits for &'a mut R

impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
    W: Write + ?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 R

impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
    W: Write + ?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 Peekable<D>

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

Formats the value using the given formatter.

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

fn default() -> Self

Returns the "default value" for a type.

impl<D: Decode> Decode for Peekable<D>

type Item = D::Item

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.