Struct tokio_util::codec::AnyDelimiterCodec [−][src]
pub struct AnyDelimiterCodec { /* fields omitted */ }
codec
only.Expand description
A simple Decoder
and Encoder
implementation that splits up data into chunks based on any character in the given delimiter string.
Example
Decode string of bytes containing various different delimiters.
use tokio_util::codec::{AnyDelimiterCodec, Decoder}; use bytes::{BufMut, BytesMut}; let mut codec = AnyDelimiterCodec::new(b",;\r\n".to_vec(),b";".to_vec()); let buf = &mut BytesMut::new(); buf.reserve(200); buf.put_slice(b"chunk 1,chunk 2;chunk 3\n\r"); assert_eq!("chunk 1", codec.decode(buf).unwrap().unwrap()); assert_eq!("chunk 2", codec.decode(buf).unwrap().unwrap()); assert_eq!("chunk 3", codec.decode(buf).unwrap().unwrap()); assert_eq!("", codec.decode(buf).unwrap().unwrap()); assert_eq!(None, codec.decode(buf).unwrap());
Implementations
impl AnyDelimiterCodec
[src]
impl AnyDelimiterCodec
[src]pub fn new(
seek_delimiters: Vec<u8>,
sequence_writer: Vec<u8>
) -> AnyDelimiterCodec
[src]
pub fn new(
seek_delimiters: Vec<u8>,
sequence_writer: Vec<u8>
) -> AnyDelimiterCodec
[src]Returns a AnyDelimiterCodec
for splitting up data into chunks.
Note
The returned AnyDelimiterCodec
will not have an upper bound on the length
of a buffered chunk. 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(
seek_delimiters: Vec<u8>,
sequence_writer: Vec<u8>,
max_length: usize
) -> Self
[src]
pub fn new_with_max_length(
seek_delimiters: Vec<u8>,
sequence_writer: Vec<u8>,
max_length: usize
) -> Self
[src]Returns a AnyDelimiterCodec
with a maximum chunk length limit.
If this is set, calls to AnyDelimiterCodec::decode
will return a
AnyDelimiterCodecError
when a chunk exceeds the length limit. Subsequent calls
will discard up to limit
bytes from that chunk until a delimiter
character is reached, returning None
until the delimiter 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 AnyDelimiterCodec
which
will be exposed to untrusted input. Otherwise, the size of the buffer
that holds the chunk currently being read is unbounded. An attacker could
exploit this unbounded buffer by sending an unbounded amount of input
without any delimiter characters, causing unbounded memory consumption.
pub fn max_length(&self) -> usize
[src]
pub fn max_length(&self) -> usize
[src]Returns the maximum chunk length when decoding.
use std::usize; use tokio_util::codec::AnyDelimiterCodec; let codec = AnyDelimiterCodec::new(b",;\n".to_vec(), b";".to_vec()); assert_eq!(codec.max_length(), usize::MAX);
use tokio_util::codec::AnyDelimiterCodec; let codec = AnyDelimiterCodec::new_with_max_length(b",;\n".to_vec(), b";".to_vec(), 256); assert_eq!(codec.max_length(), 256);
Trait Implementations
impl Clone for AnyDelimiterCodec
[src]
impl Clone for AnyDelimiterCodec
[src]fn clone(&self) -> AnyDelimiterCodec
[src]
fn clone(&self) -> AnyDelimiterCodec
[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 AnyDelimiterCodec
[src]
impl Debug for AnyDelimiterCodec
[src]impl Decoder for AnyDelimiterCodec
[src]
impl Decoder for AnyDelimiterCodec
[src]type Error = AnyDelimiterCodecError
type Error = AnyDelimiterCodecError
The type of unrecoverable frame decoding errors. Read more
fn decode(
&mut self,
buf: &mut BytesMut
) -> Result<Option<Bytes>, AnyDelimiterCodecError>
[src]
fn decode(
&mut self,
buf: &mut BytesMut
) -> Result<Option<Bytes>, AnyDelimiterCodecError>
[src]Attempts to decode a frame from the provided buffer of bytes. Read more
fn decode_eof(
&mut self,
buf: &mut BytesMut
) -> Result<Option<Bytes>, AnyDelimiterCodecError>
[src]
fn decode_eof(
&mut self,
buf: &mut BytesMut
) -> Result<Option<Bytes>, AnyDelimiterCodecError>
[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 AnyDelimiterCodec
[src]
impl Default for AnyDelimiterCodec
[src]impl<T> Encoder<T> for AnyDelimiterCodec where
T: AsRef<str>,
[src]
impl<T> Encoder<T> for AnyDelimiterCodec where
T: AsRef<str>,
[src]type Error = AnyDelimiterCodecError
type Error = AnyDelimiterCodecError
The type of encoding errors. Read more
impl Hash for AnyDelimiterCodec
[src]
impl Hash for AnyDelimiterCodec
[src]impl Ord for AnyDelimiterCodec
[src]
impl Ord for AnyDelimiterCodec
[src]impl PartialEq<AnyDelimiterCodec> for AnyDelimiterCodec
[src]
impl PartialEq<AnyDelimiterCodec> for AnyDelimiterCodec
[src]fn eq(&self, other: &AnyDelimiterCodec) -> bool
[src]
fn eq(&self, other: &AnyDelimiterCodec) -> bool
[src]This method tests for self
and other
values to be equal, and is used
by ==
. Read more
fn ne(&self, other: &AnyDelimiterCodec) -> bool
[src]
fn ne(&self, other: &AnyDelimiterCodec) -> bool
[src]This method tests for !=
.
impl PartialOrd<AnyDelimiterCodec> for AnyDelimiterCodec
[src]
impl PartialOrd<AnyDelimiterCodec> for AnyDelimiterCodec
[src]fn partial_cmp(&self, other: &AnyDelimiterCodec) -> Option<Ordering>
[src]
fn partial_cmp(&self, other: &AnyDelimiterCodec) -> 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 AnyDelimiterCodec
[src]
impl StructuralEq for AnyDelimiterCodec
[src]
impl StructuralPartialEq for AnyDelimiterCodec
[src]
Auto Trait Implementations
impl RefUnwindSafe for AnyDelimiterCodec
impl Send for AnyDelimiterCodec
impl Sync for AnyDelimiterCodec
impl Unpin for AnyDelimiterCodec
impl UnwindSafe for AnyDelimiterCodec
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