Struct SilkroadCodec 

pub struct SilkroadCodec;

A codec to read and write SilkroadFrame from/onto a byte stream. This implements Encoder and Decoder to be used in combination with tokio framed read/write. Essentially, this wraps the SilkroadFrame::serialize and SilkroadFrame::parse functions to serialize & deserialize the frames.

Trait Implementations

impl Decoder for SilkroadCodec

type Item = SilkroadFrame

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>, 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 Encoder<SilkroadFrame> for SilkroadCodec

type Error = Error

The type of encoding errors.

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

Encodes a frame into the buffer provided.