Struct codecs::decoding::framing::NewlineDelimitedDecoder

pub struct NewlineDelimitedDecoder(/* private fields */);

A codec for handling bytes that are delimited by (a) newline(s).

Implementations

impl NewlineDelimitedDecoder

pub const fn new() -> Self

Creates a new NewlineDelimitedDecoder.

pub const fn new_with_max_length(max_length: usize) -> Self

Creates a NewlineDelimitedDecoder with a maximum frame length limit.

Any frames longer than max_length bytes will be discarded entirely.

Trait Implementations

impl Clone for NewlineDelimitedDecoder

fn clone(&self) -> NewlineDelimitedDecoder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NewlineDelimitedDecoder

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

Formats the value using the given formatter.

impl Decoder for NewlineDelimitedDecoder

type Item = Bytes

The type of decoded frames.

type Error = Box<dyn FramingError>

The type of unrecoverable frame decoding errors.

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, src: &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 Default for NewlineDelimitedDecoder

fn default() -> Self

Returns the “default value” for a type.