Struct bytecodec::combinator::MaxBytes
[−]
[src]
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>
[src]
pub fn consumed_bytes(&self) -> u64
[src]
Returns the number of bytes consumed for encoding/decoding the current item.
pub fn max_bytes(&self) -> u64
[src]
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<()>
[src]
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 Wpub fn inner_ref(&self) -> &C
[src]
Returns a reference to the inner encoder or decoder.
ⓘImportant traits for &'a mut Wpub fn inner_mut(&mut self) -> &mut C
[src]
Returns a mutable reference to the inner encoder or decoder.
pub fn into_inner(self) -> C
[src]
Takes ownership of this instance and returns the inner encoder or decoder.
Trait Implementations
impl<C: Debug> Debug for MaxBytes<C>
[src]
fn fmt(&self, __arg_0: &mut Formatter) -> Result
[src]
Formats the value using the given formatter. Read more
impl<C: Default> Default for MaxBytes<C>
[src]
impl<D: Decode> Decode for MaxBytes<D>
[src]
type Item = D::Item
The type of items to be decoded.
fn decode(
&mut self,
buf: &[u8],
eos: Eos
) -> Result<(usize, Option<Self::Item>)>
[src]
&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. Read more
fn is_idle(&self) -> bool
[src]
Returns true
if there is no item being decoded by the decoder, otherwise false
.
fn requiring_bytes(&self) -> ByteCount
[src]
Returns the lower bound of the number of bytes needed to decode the next item. Read more
impl<E: Encode> Encode for MaxBytes<E>
[src]
type Item = E::Item
The type of items to be encoded.
fn encode(&mut self, buf: &mut [u8], eos: Eos) -> Result<usize>
[src]
Encodes the items in the encoder and writes the encoded bytes to the given buffer. Read more
fn start_encoding(&mut self, item: Self::Item) -> Result<()>
[src]
Tries to start encoding the given item. Read more
fn requiring_bytes(&self) -> ByteCount
[src]
Returns the number of bytes required to encode all the items in the encoder. Read more
fn is_idle(&self) -> bool
[src]
Returns true
if there are no items to be encoded in the encoder, otherwise false
.
impl<E: ExactBytesEncode> ExactBytesEncode for MaxBytes<E>
[src]
fn exact_requiring_bytes(&self) -> u64
[src]
Returns the exact number of bytes required to encode all the items remaining in the encoder.