Struct Codec

pub struct Codec<const SENTINEL_ENCODE: u8 = DEFAULT_SENTINEL, const SENTINEL_DECODE: u8 = DEFAULT_SENTINEL, const MAX_LEN_ENCODE: usize = DEFAULT_MAX_LEN, const MAX_LEN_DECODE: usize = DEFAULT_MAX_LEN> { /* private fields */ }

Frame codec.

This type contains both an Encoder and a Decoder and implements Encoder as well as Decoder.

Refer to the underlying encoder and decoder types for details on the generic parameters.

Implementations

impl<const SENTINEL_ENCODE: u8, const SENTINEL_DECODE: u8, const MAX_LEN_ENCODE: usize, const MAX_LEN_DECODE: usize> Codec<SENTINEL_ENCODE, SENTINEL_DECODE, MAX_LEN_ENCODE, MAX_LEN_DECODE>

pub fn new() -> Self

Create a new codec.

Trait Implementations

impl<const SENTINEL_ENCODE: u8, const SENTINEL_DECODE: u8, const MAX_LEN_ENCODE: usize, const MAX_LEN_DECODE: usize> Debug for Codec<SENTINEL_ENCODE, SENTINEL_DECODE, MAX_LEN_ENCODE, MAX_LEN_DECODE>

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

Formats the value using the given formatter.

impl<const SENTINEL_ENCODE: u8, const SENTINEL_DECODE: u8, const MAX_LEN_ENCODE: usize, const MAX_LEN_DECODE: usize> Decoder for Codec<SENTINEL_ENCODE, SENTINEL_DECODE, MAX_LEN_ENCODE, MAX_LEN_DECODE>

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_ENCODE: u8, const SENTINEL_DECODE: u8, const MAX_LEN_ENCODE: usize, const MAX_LEN_DECODE: usize> Default for Codec<SENTINEL_ENCODE, SENTINEL_DECODE, MAX_LEN_ENCODE, MAX_LEN_DECODE>

fn default() -> Self

Returns the “default value” for a type.

impl<const SENTINEL_ENCODE: u8, const SENTINEL_DECODE: u8, const MAX_LEN_ENCODE: usize, const MAX_LEN_DECODE: usize, T: AsRef<[u8]>> Encoder<T> for Codec<SENTINEL_ENCODE, SENTINEL_DECODE, MAX_LEN_ENCODE, MAX_LEN_DECODE>

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.