[][src]Struct tokio::codec::LinesCodec

pub struct LinesCodec { /* fields omitted */ }

A simple Codec 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) -> LinesCodec[src]

Returns a LinesCodec with a maximum line length limit.

If this is set, calls to LinesCodec::decode will return a LengthError 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_codec::LinesCodec;

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

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

Trait Implementations

impl Eq for LinesCodec[src]

impl PartialEq<LinesCodec> for LinesCodec[src]

impl Encoder for LinesCodec[src]

type Item = String

The type of items consumed by the Encoder

type Error = Error

The type of encoding errors. Read more

impl Decoder for LinesCodec[src]

type Item = String

The type of decoded frames.

type Error = Error

The type of unrecoverable frame decoding errors. Read more

fn framed<T>(self, io: T) -> Framed<T, Self> where
    Self: Encoder,
    T: AsyncRead + AsyncWrite

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

impl Hash for LinesCodec[src]

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher

Feeds a slice of this type into the given [Hasher]. Read more

impl Clone for LinesCodec[src]

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

Performs copy-assignment from source. Read more

impl PartialOrd<LinesCodec> for LinesCodec[src]

impl Ord for LinesCodec[src]

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values. Read more

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values. Read more

fn clamp(self, min: Self, max: Self) -> Self[src]

🔬 This is a nightly-only experimental API. (clamp)

Returns max if self is greater than max, and min if self is less than min. Otherwise this will return self. Panics if min > max. Read more

impl Debug for LinesCodec[src]

Auto Trait Implementations

impl Send for LinesCodec

impl Sync for LinesCodec

Blanket Implementations

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

impl<T> ToOwned for T where
    T: Clone

type Owned = T

impl<T> From for T[src]

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

type Error = Infallible

The type returned in the event of a conversion error.

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

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

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

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

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

The type returned in the event of a conversion error.

impl<T> Erased for T