Struct bytecodec::padding::PaddingDecoder

pub struct PaddingDecoder { /* fields omitted */ }

Decoder for reading padding bytes from input streams.

PaddingDecoder discards any bytes in a stream until it reaches EOS.

Methods

impl PaddingDecoder

pub fn new(expected_byte: Option<u8>) -> Self

Makes a new PaddingDecoder instance.

pub fn expected_byte(&self) -> Option<u8>

Returns the expected byte used for padding.

None means that this decoder accepts any bytes.

pub fn set_expected_byte(&mut self, b: Option<u8>)

Sets the expected byte used for padding.

Trait Implementations

impl Debug for PaddingDecoder

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

Formats the value using the given formatter.

impl Default for PaddingDecoder

fn default() -> PaddingDecoder

Returns the "default value" for a type.

impl Decode for PaddingDecoder

type 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 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.

fn requiring_bytes(&self) -> ByteCount

Returns the lower bound of the number of bytes needed to decode the next item.