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

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

A simple Codec implementation that splits up data into lines.

Methods

impl LinesCodec[src]

pub fn new() -> LinesCodec[src]

This is supported on feature="codec" only.

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.

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

This is supported on feature="codec" only.

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.

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

This is supported on feature="codec" only.

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

type Item = String

This is supported on feature="codec" only.

The type of decoded frames.

type Error = LinesCodecError

This is supported on feature="codec" only.

The type of unrecoverable frame decoding errors. Read more

impl Encoder for LinesCodec[src]

type Item = String

This is supported on feature="codec" only.

The type of items consumed by the Encoder

type Error = LinesCodecError

This is supported on feature="codec" only.

The type of encoding errors. Read more

impl Clone for LinesCodec[src]

impl Default for LinesCodec[src]

impl Eq for LinesCodec[src]

impl Ord for LinesCodec[src]

impl PartialEq<LinesCodec> for LinesCodec[src]

impl PartialOrd<LinesCodec> for LinesCodec[src]

impl Debug for LinesCodec[src]

impl Hash for LinesCodec[src]

impl StructuralPartialEq for LinesCodec[src]

impl StructuralEq for LinesCodec[src]

Auto Trait Implementations

Blanket Implementations

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

impl<T> From<T> for T[src]

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

type Owned = T

The resulting type after obtaining ownership.

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

type Error = Infallible

The type returned in the event of a conversion error.

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

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

The type returned in the event of a conversion error.

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

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

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