Struct BinCodec 

pub struct BinCodec<T>(/* private fields */);

Available on crate feature tokio only.

A tokio_util::codec codec that frames any bnb #[bin] message T. Construct with BinCodec::new and hand it to Framed.

Implementations

impl<T> BinCodec<T>

pub fn new() -> Self

A codec for messages of type T.

Trait Implementations

impl<T: BitDecode + BitEncode> Decoder for BinCodec<T>

type Item = T

The type of decoded frames.

type Error = Error

The type of unrecoverable frame decoding errors.

fn decode(&mut self, src: &mut BytesMut) -> Result<Option<T>, 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<T> Default for BinCodec<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: BitEncode> Encoder<T> for BinCodec<T>

type Error = Error

The type of encoding errors.

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

Encodes a frame into the buffer provided.