Struct Encoder 

pub struct Encoder<const SENTINEL: u8 = DEFAULT_SENTINEL, const MAX_LEN: usize = DEFAULT_MAX_LEN>;

Frame encoder.

This type implements Encoder<impl AsRef<[i8]>>; it encodes any message type that be converted to a byte slice using AsRef<[u8]>.

This type can be customized via generic parameters:
SENTINEL: Choose a byte to be used as a frame separator. The corresponding Decoder 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 an optimization. If any message exceeds this limit, encoding will panic.

Implementations

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

pub fn new() -> Self

Create a new encoder.

Trait Implementations

impl<const SENTINEL: u8, const MAX_LEN: usize> Debug for Encoder<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> Default for Encoder<SENTINEL, MAX_LEN>

fn default() -> Encoder<SENTINEL, MAX_LEN>

Returns the “default value” for a type.

impl<const SENTINEL: u8, const MAX_LEN: usize, T: AsRef<[u8]>> Encoder<T> for Encoder<SENTINEL, MAX_LEN>

type Error = Error

The type of encoding errors.

fn encode(&mut self, item: T, dst: &mut BytesMut) -> Result<(), Self::Error>

Encodes a frame into the buffer provided.