pub struct LengthDelimitedCodec { /* private fields */ }
Expand description

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.

Implementations§

source§

impl LengthDelimitedCodec

source

pub fn new() -> Self

Creates a new LengthDelimitedCodec with the default configuration values.

source

pub fn builder() -> Builder

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

source

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.

source

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.

Trait Implementations§

source§

impl Clone for LengthDelimitedCodec

source§

fn clone(&self) -> LengthDelimitedCodec

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for LengthDelimitedCodec

source§

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

Formats the value using the given formatter. Read more
source§

impl Decoder for LengthDelimitedCodec

§

type Item = BytesMut

The type of decoded frames.
§

type Error = Error

The type of unrecoverable frame decoding errors. Read more
source§

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

Attempts to decode a frame from the provided buffer of bytes. Read more
source§

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. Read more
source§

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. Read more
source§

impl Default for LengthDelimitedCodec

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

impl Encoder<Bytes> for LengthDelimitedCodec

§

type Error = Error

The type of encoding errors. Read more
source§

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

Encodes a frame into the buffer provided. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

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.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.