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

pub struct LinesCodec { /* fields omitted */ }

A simple Codec implementation that splits up data into lines.

Methods

impl LinesCodec
[src]

Returns a LinesCodec for splitting up data into lines.

Note

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.

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.

Note

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.

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 Ord for LinesCodec
[src]

Compares and returns the maximum of two values. Read more

Compares and returns the minimum of two values. Read more

impl PartialEq<LinesCodec> for LinesCodec
[src]

impl Decoder for LinesCodec
[src]

The type of decoded frames.

The type of unrecoverable frame decoding errors. Read more

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 Eq for LinesCodec
[src]

impl Debug for LinesCodec
[src]

impl Hash for LinesCodec
[src]

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

impl Encoder for LinesCodec
[src]

The type of items consumed by the Encoder

The type of encoding errors. Read more

impl Clone for LinesCodec
[src]

Performs copy-assignment from source. Read more

impl PartialOrd<LinesCodec> for LinesCodec
[src]

Auto Trait Implementations

impl Send for LinesCodec

impl Sync for LinesCodec

Blanket Implementations

impl<T> From for T
[src]

impl<T, U> Into for T where
    U: From<T>, 
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

impl<T, U> TryFrom for T where
    T: From<U>, 
[src]

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

The type returned in the event of a conversion error.

impl<T> Borrow for T where
    T: ?Sized
[src]

impl<T> BorrowMut for T where
    T: ?Sized
[src]

impl<T, U> TryInto for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.

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

impl<T> Erased for T