Struct LinesCodec 

#[non_exhaustive]
pub struct LinesCodec { /* private fields */ }

Lines codec. Reads/writes line delimited strings.

Will split input up by LF or CRLF delimiters. Carriage return characters at the end of lines are not preserved.

Security

When used with untrusted input, it is recommended to set a maximum line length with LinesCodec::new_with_max_length. Without a length limit, the internal read buffer can grow without bound if a peer sends an unbounded amount of data without a \n, potentially leading to memory exhaustion (DoS).

Implementations

impl LinesCodec

pub const fn new() -> Self

Creates a new LinesCodec with no maximum line length.

Consider using LinesCodec::new_with_max_length when working with untrusted input.

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

Creates a new LinesCodec with a maximum line length, in bytes.

The limit applies to the bytes before the line delimiter (\n). If present, a trailing carriage return (\r) in \r\n sequences is not counted towards the limit.

Using a length limit is recommended when working with untrusted input to avoid unbounded buffering.

pub const fn max_length(&self) -> usize

Returns the maximum permitted line length, in bytes.

Trait Implementations

impl Clone for LinesCodec

fn clone(&self) -> LinesCodec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for LinesCodec

impl Debug for LinesCodec

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

Formats the value using the given formatter.

impl Decoder for LinesCodec

type Item = String

The type of decoded frames.

type Error = Error

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 LinesCodec

fn default() -> Self

Returns the “default value” for a type.

impl<T: AsRef<str>> Encoder<T> for LinesCodec

type Error = Error

The type of encoding errors.

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

Encodes a frame into the buffer provided.