Struct MessageCodec 

pub struct MessageCodec<T> { /* private fields */ }

A message encoder/decoder to help frame messages sent over TCP, particularly in the case of very large messages. Uses a very simple method of writing the length of the serialized message at the very start of a frame, followed by the serialized message. When decoding, this length is used to determine if a full frame has been read.

Trait Implementations

impl<T: Debug> Debug for MessageCodec<T>

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

Formats the value using the given formatter.

impl<T: DeserializeOwned> Decoder for MessageCodec<T>

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

Decodes a message by reading the length of the message (at the start of a frame) and then reading that many bytes from a buffer to complete the frame.

type Item = Message<T>

The type of decoded frames.

type Error = LiquidError

The type of unrecoverable frame decoding errors.

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<T: Serialize> Encoder<Message<T>> for MessageCodec<T>

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

Encodes a message by writing the length of the serialized message at the start of a frame, and then writing that many bytes into a buffer to be sent.

type Error = LiquidError

The type of encoding errors.