Struct tokio_util::codec::length_delimited::LengthDelimitedCodec

pub struct LengthDelimitedCodec {
    builder: Builder,
    state: DecodeState,
}

A codec for frames delimited by a frame head specifying their lengths.

This allows the consumer to work with entire frames without having to worry about buffering or other framing logic.

See module level documentation for more detail.

Fields

builder: Builder

state: DecodeState

Implementations

impl LengthDelimitedCodec

pub fn new() -> Self

Creates a new LengthDelimitedCodec with the default configuration values.

pub fn builder() -> Builder

Creates a new length delimited codec builder with default configuration values.

pub fn max_frame_length(&self) -> usize

Returns the current max frame setting

This is the largest size this codec will accept from the wire. Larger frames will be rejected.

pub fn set_max_frame_length(&mut self, val: usize)

Updates the max frame setting.

The change takes effect the next time a frame is decoded. In other words, if a frame is currently in process of being decoded with a frame size greater than val but less than the max frame length in effect before calling this function, then the frame will be allowed.

fn decode_head(&mut self, src: &mut BytesMut) -> Result<Option<usize>>

fn decode_data(&self, n: usize, src: &mut BytesMut) -> Option<BytesMut>

Trait Implementations

impl Clone for LengthDelimitedCodec

fn clone(&self) -> LengthDelimitedCodec

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LengthDelimitedCodec

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

Formats the value using the given formatter.

impl Decoder for LengthDelimitedCodec

type Item = BytesMut

The type of decoded frames.

type Error = Error

The type of unrecoverable frame decoding errors.

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

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: AsyncRead + AsyncWrite + Sized>(self, io: T) -> Framed<T, Self>

where 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 Default for LengthDelimitedCodec

fn default() -> Self

Returns the “default value” for a type.

impl Encoder<Bytes> for LengthDelimitedCodec

type Error = Error

The type of encoding errors.

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

Encodes a frame into the buffer provided.