Struct LengthDelimitedCodec

pub struct LengthDelimitedCodec<F> { /* private fields */ }

A codec for decoding and decoding length-delimited frames that implement LengthDelimitedFrame.

Implementations

impl<F> LengthDelimitedCodec<F>

pub const fn new() -> Self

Create a new LengthDelimitedCodec instance for [F].

Trait Implementations

impl<F: Clone> Clone for LengthDelimitedCodec<F>

fn clone(&self) -> LengthDelimitedCodec<F>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<F: Debug> Debug for LengthDelimitedCodec<F>

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

Formats the value using the given formatter.

impl<F> Decoder for LengthDelimitedCodec<F>

where F: LengthDelimitedFrame,

type Error = <F as LengthDelimitedFrame>::Error

The type of unrecoverable frame decoding errors.

type Item = F

The type of decoded frames.

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<F> Encoder<F> for LengthDelimitedCodec<F>

where F: LengthDelimitedFrame,

type Error = <F as LengthDelimitedFrame>::Error

The type of encoding errors.

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

Encodes a frame into the buffer provided.