[−][src]Struct tokio::codec::LinesCodec
A simple Codec
implementation that splits up data into lines.
Methods
impl LinesCodec
[src]
impl LinesCodec
pub fn new() -> LinesCodec
[src]
pub fn new() -> LinesCodec
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) -> LinesCodec
[src]
pub fn new_with_max_length(max_length: usize) -> LinesCodec
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]
pub fn max_length(&self) -> usize
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]
impl Ord for LinesCodec
fn cmp(&self, other: &LinesCodec) -> Ordering
[src]
fn cmp(&self, other: &LinesCodec) -> Ordering
This method returns an Ordering
between self
and other
. Read more
fn max(self, other: Self) -> Self
1.21.0[src]
fn max(self, other: Self) -> Self
Compares and returns the maximum of two values. Read more
fn min(self, other: Self) -> Self
1.21.0[src]
fn min(self, other: Self) -> Self
Compares and returns the minimum of two values. Read more
impl PartialEq<LinesCodec> for LinesCodec
[src]
impl PartialEq<LinesCodec> for LinesCodec
fn eq(&self, other: &LinesCodec) -> bool
[src]
fn eq(&self, other: &LinesCodec) -> bool
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
This method tests for !=
.
impl Debug for LinesCodec
[src]
impl Debug for LinesCodec
fn fmt(&self, f: &mut Formatter) -> Result<(), Error>
[src]
fn fmt(&self, f: &mut Formatter) -> Result<(), Error>
Formats the value using the given formatter. Read more
impl Eq for LinesCodec
[src]
impl Eq for LinesCodec
impl Decoder for LinesCodec
[src]
impl Decoder for LinesCodec
type Item = String
The type of decoded frames.
type Error = Error
The type of unrecoverable frame decoding errors. Read more
fn decode(&mut self, buf: &mut BytesMut) -> Result<Option<String>, Error>
[src]
fn decode(&mut self, buf: &mut BytesMut) -> Result<Option<String>, Error>
Attempts to decode a frame from the provided buffer of bytes. Read more
fn decode_eof(&mut self, buf: &mut BytesMut) -> Result<Option<String>, Error>
[src]
fn decode_eof(&mut self, buf: &mut BytesMut) -> Result<Option<String>, Error>
A default method available to be called when there are no more bytes available to be read from the underlying I/O. Read more
fn framed<T>(self, io: T) -> Framed<T, Self> where
Self: Encoder,
T: AsyncRead + AsyncWrite,
[src]
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 Encoder for LinesCodec
[src]
impl Encoder for LinesCodec
type Item = String
The type of items consumed by the Encoder
type Error = Error
The type of encoding errors. Read more
fn encode(&mut self, line: String, buf: &mut BytesMut) -> Result<(), Error>
[src]
fn encode(&mut self, line: String, buf: &mut BytesMut) -> Result<(), Error>
Encodes a frame into the buffer provided. Read more
impl Hash for LinesCodec
[src]
impl Hash for LinesCodec
fn hash<__H>(&self, state: &mut __H) where
__H: Hasher,
[src]
fn hash<__H>(&self, state: &mut __H) where
__H: Hasher,
Feeds this value into the given [Hasher
]. Read more
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[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]
impl Clone for LinesCodec
fn clone(&self) -> LinesCodec
[src]
fn clone(&self) -> LinesCodec
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)
Performs copy-assignment from source
. Read more
impl PartialOrd<LinesCodec> for LinesCodec
[src]
impl PartialOrd<LinesCodec> for LinesCodec
fn partial_cmp(&self, other: &LinesCodec) -> Option<Ordering>
[src]
fn partial_cmp(&self, other: &LinesCodec) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
fn lt(&self, other: &LinesCodec) -> bool
[src]
fn lt(&self, other: &LinesCodec) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
fn le(&self, other: &LinesCodec) -> bool
[src]
fn le(&self, other: &LinesCodec) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
fn gt(&self, other: &LinesCodec) -> bool
[src]
fn gt(&self, other: &LinesCodec) -> bool
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
fn ge(&self, other: &LinesCodec) -> bool
[src]
fn ge(&self, other: &LinesCodec) -> bool
This method tests greater than or equal to (for self
and other
) and is used by the >=
operator. Read more
Auto Trait Implementations
impl Send for LinesCodec
impl Send for LinesCodec
impl Sync for LinesCodec
impl Sync for LinesCodec
Blanket Implementations
impl<T, U> Into for T where
U: From<T>,
[src]
impl<T, U> Into for T where
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
type Owned = T
fn to_owned(&self) -> T
[src]
fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
fn clone_into(&self, target: &mut T)
[src]
fn clone_into(&self, target: &mut T)
🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
impl<T> From for T
[src]
impl<T> From for T
impl<T, U> TryFrom for T where
T: From<U>,
[src]
impl<T, U> TryFrom for T where
T: From<U>,
type Error = !
try_from
)The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
try_from
)Performs the conversion.
impl<T> Borrow for T where
T: ?Sized,
[src]
impl<T> Borrow for T where
T: ?Sized,
ⓘImportant traits for &'a mut Wfn borrow(&self) -> &T
[src]
fn borrow(&self) -> &T
Immutably borrows from an owned value. Read more
impl<T> BorrowMut for T where
T: ?Sized,
[src]
impl<T> BorrowMut for T where
T: ?Sized,
ⓘImportant traits for &'a mut Wfn borrow_mut(&mut self) -> &mut T
[src]
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<T, U> TryInto for T where
U: TryFrom<T>,
[src]
impl<T, U> TryInto for T where
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
try_from
)The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
try_from
)Performs the conversion.
impl<T> Any for T where
T: 'static + ?Sized,
[src]
impl<T> Any for T where
T: 'static + ?Sized,
fn get_type_id(&self) -> TypeId
[src]
fn get_type_id(&self) -> TypeId
🔬 This is a nightly-only experimental API. (get_type_id
)
this method will likely be replaced by an associated static
Gets the TypeId
of self
. Read more
impl<T> Erased for T
[src]
impl<T> Erased for T