Struct MessageCodec

pub struct MessageCodec<N: Network> { /* private fields */ }

The codec used to decode and encode network Messages.

Implementations

impl<N: Network> MessageCodec<N>

pub fn handshake() -> Self

Trait Implementations

impl<N: Network> Decoder for MessageCodec<N>

type Error = Error

The type of unrecoverable frame decoding errors.

type Item = Message<N>

The type of decoded frames.

fn decode( &mut self, source: &mut BytesMut, ) -> Result<Option<Self::Item>, 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<N: Network> Default for MessageCodec<N>

fn default() -> Self

Returns the “default value” for a type.

impl<N: Network> Encoder<Message<N>> for MessageCodec<N>

type Error = Error

The type of encoding errors.

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

Encodes a frame into the buffer provided.