Struct tokio_util::codec::LinesCodec[][src]

pub struct LinesCodec { /* fields omitted */ }
This is supported on crate feature codec only.

A simple Decoder and Encoder implementation that splits up data into lines.


impl LinesCodec[src]

pub fn new() -> LinesCodec[src]

Returns a LinesCodec for splitting up data into lines.


The returned LinesCodec will not have an upper bound on the length of a buffered line. See the documentation for new_with_max_length for information on why this could be a potential security risk.

pub fn new_with_max_length(max_length: usize) -> Self[src]

Returns a LinesCodec with a maximum line length limit.

If this is set, calls to LinesCodec::decode will return a LinesCodecError when a line exceeds the length limit. Subsequent calls will discard up to limit bytes from that line until a newline character is reached, returning None until the line over the limit has been fully discarded. After that point, calls to decode will function as normal.


Setting a length limit is highly recommended for any LinesCodec which will be exposed to untrusted input. Otherwise, the size of the buffer that holds the line currently being read is unbounded. An attacker could exploit this unbounded buffer by sending an unbounded amount of input without any \n characters, causing unbounded memory consumption.

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

Returns the maximum line length when decoding.

use std::usize;
use tokio_util::codec::LinesCodec;

let codec = LinesCodec::new();
assert_eq!(codec.max_length(), usize::MAX);
use tokio_util::codec::LinesCodec;

let codec = LinesCodec::new_with_max_length(256);
assert_eq!(codec.max_length(), 256);

Trait Implementations

impl Clone for LinesCodec[src]

impl Debug for LinesCodec[src]

impl Decoder for LinesCodec[src]

type Item = String

The type of decoded frames.

type Error = LinesCodecError

The type of unrecoverable frame decoding errors. Read more

impl Default for LinesCodec[src]

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

type Error = LinesCodecError

The type of encoding errors. Read more

impl Eq for LinesCodec[src]

impl Hash for LinesCodec[src]

impl Ord for LinesCodec[src]

impl PartialEq<LinesCodec> for LinesCodec[src]

impl PartialOrd<LinesCodec> for LinesCodec[src]

impl StructuralEq for LinesCodec[src]

impl StructuralPartialEq for LinesCodec[src]

Auto Trait Implementations

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> ToOwned for T where
    T: Clone

type Owned = T

The resulting type after obtaining ownership.

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.