Struct bytecodec::combinator::Omittable [−][src]
pub struct Omittable<D> { /* fields omitted */ }
Combinator for representing optional decoders.
This is created by calling DecodeExt::omit
method.
Methods
impl<D> Omittable<D>
[src]
impl<D> Omittable<D>
ⓘImportant traits for &'a mut Rpub fn inner_ref(&self) -> &D
[src]
pub fn inner_ref(&self) -> &D
Returns a reference to the inner decoder.
ⓘImportant traits for &'a mut Rpub fn inner_mut(&mut self) -> &mut D
[src]
pub fn inner_mut(&mut self) -> &mut D
Returns a mutable reference to the inner decoder.
pub fn into_inner(self) -> D
[src]
pub fn into_inner(self) -> D
Takes ownership of this instance and returns the inner decoder.
pub fn do_omit(&mut self, b: bool)
[src]
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
[src]
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>
[src]
impl<D: Debug> Debug for Omittable<D>
fn fmt(&self, f: &mut Formatter) -> Result
[src]
fn fmt(&self, f: &mut Formatter) -> Result
Formats the value using the given formatter. Read more
impl<D: Default> Default for Omittable<D>
[src]
impl<D: Default> Default for Omittable<D>
impl<D: Decode> Decode for Omittable<D>
[src]
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>
[src]
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. Read more
fn finish_decoding(&mut self) -> Result<Self::Item>
[src]
fn finish_decoding(&mut self) -> Result<Self::Item>
Finishes the current decoding process and returns the decoded item. Read more
fn requiring_bytes(&self) -> ByteCount
[src]
fn requiring_bytes(&self) -> ByteCount
Returns the lower bound of the number of bytes needed to decode the next item. Read more
fn is_idle(&self) -> bool
[src]
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
. Read more