[][src]Struct tokio_util::codec::length_delimited::LengthDelimitedCodec

pub struct LengthDelimitedCodec { /* fields omitted */ }

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.


impl LengthDelimitedCodec[src]

pub fn new() -> Self[src]

Creates a new LengthDelimitedCodec with the default configuration values.

pub fn builder() -> Builder[src]

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

pub fn max_frame_length(&self) -> usize[src]

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)[src]

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.

Trait Implementations

impl Debug for LengthDelimitedCodec[src]

impl Decoder for LengthDelimitedCodec[src]

type Item = BytesMut

The type of decoded frames.

type Error = Error

The type of unrecoverable frame decoding errors. Read more

impl Default for LengthDelimitedCodec[src]

impl Encoder for LengthDelimitedCodec[src]

type Item = Bytes

The type of items consumed by the Encoder

type Error = Error

The type of encoding errors. Read more

Auto Trait Implementations

impl RefUnwindSafe for LengthDelimitedCodec

impl Send for LengthDelimitedCodec

impl Sync for LengthDelimitedCodec

impl Unpin for LengthDelimitedCodec

impl UnwindSafe for LengthDelimitedCodec

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized

impl<T> Borrow<T> for T where
    T: ?Sized

impl<T> BorrowMut<T> for T where
    T: ?Sized

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.