Struct bytecodec::combinator::MaxBytes

pub struct MaxBytes<C> { /* fields omitted */ }

Combinator that will fail if the number of consumed bytes exceeds the specified size.

This is created by calling {DecodeExt, EncodeExt}::max_bytes method.

Note that MaxBytes assumes the inner decoder will consume all the bytes in the target stream.

Methods

impl<C> MaxBytes<C>

pub fn consumed_bytes(&self) -> u64

Returns the number of bytes consumed for encoding/decoding the current item.

pub fn max_bytes(&self) -> u64

Returns the maximum number of bytes that can be consumed for encoding/decoding an item.

pub fn set_max_bytes(&mut self, n: u64) -> Result<()>

Sets the maximum number of bytes that can be consumed for encoding/decoding an item.

Error

If n is smaller than self.consumed_bytes(), an ErrorKind::InvalidInput error will be returned.

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

Returns a reference to the inner encoder or 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 C

Returns a mutable reference to the inner encoder or decoder.

pub fn into_inner(self) -> C

Takes ownership of this instance and returns the inner encoder or decoder.

Trait Implementations

impl<C: Debug> Debug for MaxBytes<C>

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

Formats the value using the given formatter.

impl<C: Default> Default for MaxBytes<C>

fn default() -> MaxBytes<C>

Returns the "default value" for a type.

impl<D: Decode> Decode for MaxBytes<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.

impl<E: Encode> Encode for MaxBytes<E>

type Item = 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 MaxBytes<E>

fn exact_requiring_bytes(&self) -> u64

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