Struct bytecodec::combinator::Optional

pub struct Optional<E>(_);

Combinator for representing an optional encoder.

Methods

impl<E> Optional<E>

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) -> &E

Returns a reference to the inner encoder.

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 E

Returns a mutable reference to the inner encoder.

pub fn into_inner(self) -> E

Takes ownership of this instance and returns the inner encoder.

Trait Implementations

impl<E: Debug> Debug for Optional<E>

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

Formats the value using the given formatter.

impl<E: Default> Default for Optional<E>

fn default() -> Optional<E>

Returns the "default value" for a type.

impl<E: Encode> Encode for Optional<E>

type Item = Option<E::Item>

The type of items to be encoded.

fn encode(&mut self, buf: &mut [u8], eos: Eos) -> Result<usize>

Encodes the items in the encoder and writes the encoded bytes to the given buffer.

fn start_encoding(&mut self, item: Self::Item) -> Result<()>

Tries to start encoding the given item.

fn requiring_bytes(&self) -> ByteCount

Returns the number of bytes required to encode all the items in the encoder.

fn is_idle(&self) -> bool

Returns true if there are no items to be encoded in the encoder, otherwise false.

impl<E: SizedEncode> SizedEncode for Optional<E>

fn exact_requiring_bytes(&self) -> u64

Returns the exact number of bytes required to encode all the items remaining in the encoder.