Struct bytecodec::combinator::Omittable

pub struct Omittable<D> { /* fields omitted */ }

Combinator for representing optional decoders.

This is created by calling DecodeExt::omit method.

Methods

impl<D> Omittable<D>

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.

pub fn do_omit(&mut self, b: bool)

If true is specified, the decoder will consume no bytes and return Ok((0, None)) when decode method is called.

pub fn will_omit(&self) -> bool

Returns true if the decoder will omit to decode items, otherwise false.

Trait Implementations

impl<D: Debug> Debug for Omittable<D>

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

Formats the value using the given formatter.

impl<D: Default> Default for Omittable<D>

fn default() -> Omittable<D>

Returns the "default value" for a type.

impl<D: Decode> Decode for Omittable<D>

type Item = Option<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.