Struct tokio_util::codec::LinesCodec [−][src]
pub struct LinesCodec { /* fields omitted */ }
codec
only.Implementations
impl LinesCodec
[src]
impl LinesCodec
[src]pub fn new() -> LinesCodec
[src]
pub fn new() -> 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.
pub fn new_with_max_length(max_length: usize) -> Self
[src]
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.
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]
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 Clone for LinesCodec
[src]fn clone(&self) -> LinesCodec
[src]
fn clone(&self) -> LinesCodec
[src]Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]Performs copy-assignment from source
. Read more
impl Debug for LinesCodec
[src]
impl Debug for LinesCodec
[src]impl Decoder for LinesCodec
[src]
impl Decoder for LinesCodec
[src]type Error = LinesCodecError
type Error = LinesCodecError
The type of unrecoverable frame decoding errors. Read more
fn decode(
&mut self,
buf: &mut BytesMut
) -> Result<Option<String>, LinesCodecError>
[src]
fn decode(
&mut self,
buf: &mut BytesMut
) -> Result<Option<String>, LinesCodecError>
[src]Attempts to decode a frame from the provided buffer of bytes. Read more
fn decode_eof(
&mut self,
buf: &mut BytesMut
) -> Result<Option<String>, LinesCodecError>
[src]
fn decode_eof(
&mut self,
buf: &mut BytesMut
) -> Result<Option<String>, LinesCodecError>
[src]A default method available to be called when there are no more bytes available to be read from the underlying I/O. Read more
impl Default for LinesCodec
[src]
impl Default for LinesCodec
[src]impl<T> Encoder<T> for LinesCodec where
T: AsRef<str>,
[src]
impl<T> Encoder<T> for LinesCodec where
T: AsRef<str>,
[src]type Error = LinesCodecError
type Error = LinesCodecError
The type of encoding errors. Read more
impl Hash for LinesCodec
[src]
impl Hash for LinesCodec
[src]impl Ord for LinesCodec
[src]
impl Ord for LinesCodec
[src]impl PartialEq<LinesCodec> for LinesCodec
[src]
impl PartialEq<LinesCodec> for LinesCodec
[src]fn eq(&self, other: &LinesCodec) -> bool
[src]
fn eq(&self, other: &LinesCodec) -> bool
[src]This method tests for self
and other
values to be equal, and is used
by ==
. Read more
fn ne(&self, other: &LinesCodec) -> bool
[src]
fn ne(&self, other: &LinesCodec) -> bool
[src]This method tests for !=
.
impl PartialOrd<LinesCodec> for LinesCodec
[src]
impl PartialOrd<LinesCodec> for LinesCodec
[src]fn partial_cmp(&self, other: &LinesCodec) -> Option<Ordering>
[src]
fn partial_cmp(&self, other: &LinesCodec) -> Option<Ordering>
[src]This method returns an ordering between self
and other
values if one exists. Read more
#[must_use]fn lt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]fn lt(&self, other: &Rhs) -> bool
1.0.0[src]This method tests less than (for self
and other
) and is used by the <
operator. Read more
#[must_use]fn le(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]fn le(&self, other: &Rhs) -> bool
1.0.0[src]This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
impl Eq for LinesCodec
[src]
impl StructuralEq for LinesCodec
[src]
impl StructuralPartialEq for LinesCodec
[src]
Auto Trait Implementations
impl RefUnwindSafe for LinesCodec
impl Send for LinesCodec
impl Sync for LinesCodec
impl Unpin for LinesCodec
impl UnwindSafe for LinesCodec
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more