Struct Decoder 

pub struct Decoder<const SENTINEL: u8 = DEFAULT_SENTINEL, const MAX_LEN: usize = DEFAULT_MAX_LEN> { /* private fields */ }

Frame decoder.

This type implements Decoder; it decodes into BytesMut.

This type can be customized via generic parameters:
SENTINEL: Choose a byte to be used as a frame separator. The corresponding Encoder must use the same value. Refer to the crate documentation for more details on choosing a sentinel.
MAX_LEN: Choose the maximum size of a message, or set to 0 for unlimited message sizes. This parameter is used as a safety measure to prevent running out of memory. If any message exceeds this limit, decoding will return DecodeError::FrameOverflow.

Implementations

impl<const SENTINEL: u8, const MAX_LEN: usize> Decoder<SENTINEL, MAX_LEN>

pub fn new() -> Self

Create a new decoder.

Trait Implementations

impl<const SENTINEL: u8, const MAX_LEN: usize> Debug for Decoder<SENTINEL, MAX_LEN>

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

Formats the value using the given formatter.

impl<const SENTINEL: u8, const MAX_LEN: usize> Decoder for Decoder<SENTINEL, MAX_LEN>

type Item = BytesMut

The type of decoded frames.

type Error = DecodeError

The type of unrecoverable frame decoding errors.

fn decode( &mut self, src: &mut BytesMut, ) -> Result<Option<BytesMut>, Self::Error>

Attempts to decode a frame from the provided buffer of bytes.

fn decode_eof( &mut self, buf: &mut BytesMut, ) -> Result<Option<Self::Item>, Self::Error>

A default method available to be called when there are no more bytes available to be read from the underlying I/O.

fn framed<T>(self, io: T) -> Framed<T, Self>

where T: AsyncRead + AsyncWrite, Self: Sized,

Provides a Stream and Sink interface for reading and writing to this Io object, using Decode and Encode to read and write the raw data.

impl<const SENTINEL: u8, const MAX_LEN: usize> Default for Decoder<SENTINEL, MAX_LEN>

fn default() -> Self

Returns the “default value” for a type.