Struct Codec

pub struct Codec { /* private fields */ }

TODO(ppiotr3k): write description

Implementations

impl Codec

pub const fn new() -> Self

TODO(ppiotr3k): write function description

Trait Implementations

impl Clone for Codec

fn clone(&self) -> Codec

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Codec

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

Formats the value using the given formatter.

impl Decoder for Codec

type Item = Message

The type of decoded frames.

type Error = Error

The type of unrecoverable frame decoding errors.

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

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 Default for Codec

fn default() -> Self

Returns the “default value” for a type.

impl Encoder<Message> for Codec

type Error = Error

The type of encoding errors.

fn encode(&mut self, msg: Message, dst: &mut BytesMut) -> Result<(), Error>

Encodes a frame into the buffer provided.