Struct tokio_util::codec::AnyDelimiterCodec [−][src]
pub struct AnyDelimiterCodec { /* fields omitted */ }
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]
pub fn new(
seek_delimiters: Vec<u8>,
sequence_writer: Vec<u8>
) -> AnyDelimiterCodec
[src]
seek_delimiters: Vec<u8>,
sequence_writer: Vec<u8>
) -> AnyDelimiterCodec
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]
seek_delimiters: Vec<u8>,
sequence_writer: Vec<u8>,
max_length: usize
) -> Self
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]
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]
fn clone(&self) -> AnyDelimiterCodec
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Debug for AnyDelimiterCodec
[src]
impl Decoder for AnyDelimiterCodec
[src]
type Item = Bytes
The type of decoded frames.
type Error = AnyDelimiterCodecError
The type of unrecoverable frame decoding errors. Read more
fn decode(
&mut self,
buf: &mut BytesMut
) -> Result<Option<Bytes>, AnyDelimiterCodecError>
[src]
&mut self,
buf: &mut BytesMut
) -> Result<Option<Bytes>, AnyDelimiterCodecError>
fn decode_eof(
&mut self,
buf: &mut BytesMut
) -> Result<Option<Bytes>, AnyDelimiterCodecError>
[src]
&mut self,
buf: &mut BytesMut
) -> Result<Option<Bytes>, AnyDelimiterCodecError>
fn framed<T: AsyncRead + AsyncWrite + Sized>(self, io: T) -> Framed<T, Self> where
Self: Sized,
[src]
Self: Sized,
impl Default for AnyDelimiterCodec
[src]
impl<T> Encoder<T> for AnyDelimiterCodec where
T: AsRef<str>,
[src]
T: AsRef<str>,
type Error = AnyDelimiterCodecError
The type of encoding errors. Read more
fn encode(
&mut self,
chunk: T,
buf: &mut BytesMut
) -> Result<(), AnyDelimiterCodecError>
[src]
&mut self,
chunk: T,
buf: &mut BytesMut
) -> Result<(), AnyDelimiterCodecError>
impl Eq for AnyDelimiterCodec
[src]
impl Hash for AnyDelimiterCodec
[src]
fn hash<__H: Hasher>(&self, state: &mut __H)
[src]
pub fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
impl Ord for AnyDelimiterCodec
[src]
fn cmp(&self, other: &AnyDelimiterCodec) -> Ordering
[src]
#[must_use]pub fn max(self, other: Self) -> Self
1.21.0[src]
#[must_use]pub fn min(self, other: Self) -> Self
1.21.0[src]
#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self
1.50.0[src]
impl PartialEq<AnyDelimiterCodec> for AnyDelimiterCodec
[src]
fn eq(&self, other: &AnyDelimiterCodec) -> bool
[src]
fn ne(&self, other: &AnyDelimiterCodec) -> bool
[src]
impl PartialOrd<AnyDelimiterCodec> for AnyDelimiterCodec
[src]
fn partial_cmp(&self, other: &AnyDelimiterCodec) -> Option<Ordering>
[src]
#[must_use]pub fn lt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn le(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn gt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn ge(&self, other: &Rhs) -> bool
1.0.0[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> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,