Struct tokio_util::codec::AnyDelimiterCodec
source · pub struct AnyDelimiterCodec { /* private fields */ }
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§
source§impl AnyDelimiterCodec
impl AnyDelimiterCodec
sourcepub fn new(
seek_delimiters: Vec<u8>,
sequence_writer: Vec<u8>,
) -> AnyDelimiterCodec
pub fn new( 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.
sourcepub fn new_with_max_length(
seek_delimiters: Vec<u8>,
sequence_writer: Vec<u8>,
max_length: usize,
) -> Self
pub fn new_with_max_length( 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.
sourcepub fn max_length(&self) -> usize
pub fn max_length(&self) -> usize
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§
source§impl Clone for AnyDelimiterCodec
impl Clone for AnyDelimiterCodec
source§fn clone(&self) -> AnyDelimiterCodec
fn clone(&self) -> AnyDelimiterCodec
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for AnyDelimiterCodec
impl Debug for AnyDelimiterCodec
source§impl Decoder for AnyDelimiterCodec
impl Decoder for AnyDelimiterCodec
§type Error = AnyDelimiterCodecError
type Error = AnyDelimiterCodecError
source§fn decode(
&mut self,
buf: &mut BytesMut,
) -> Result<Option<Bytes>, AnyDelimiterCodecError>
fn decode( &mut self, buf: &mut BytesMut, ) -> Result<Option<Bytes>, AnyDelimiterCodecError>
source§fn decode_eof(
&mut self,
buf: &mut BytesMut,
) -> Result<Option<Bytes>, AnyDelimiterCodecError>
fn decode_eof( &mut self, buf: &mut BytesMut, ) -> Result<Option<Bytes>, AnyDelimiterCodecError>
source§impl Default for AnyDelimiterCodec
impl Default for AnyDelimiterCodec
source§impl<T> Encoder<T> for AnyDelimiterCodec
impl<T> Encoder<T> for AnyDelimiterCodec
source§impl Hash for AnyDelimiterCodec
impl Hash for AnyDelimiterCodec
source§impl Ord for AnyDelimiterCodec
impl Ord for AnyDelimiterCodec
source§fn cmp(&self, other: &AnyDelimiterCodec) -> Ordering
fn cmp(&self, other: &AnyDelimiterCodec) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
source§impl PartialEq for AnyDelimiterCodec
impl PartialEq for AnyDelimiterCodec
source§fn eq(&self, other: &AnyDelimiterCodec) -> bool
fn eq(&self, other: &AnyDelimiterCodec) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd for AnyDelimiterCodec
impl PartialOrd for AnyDelimiterCodec
source§fn partial_cmp(&self, other: &AnyDelimiterCodec) -> Option<Ordering>
fn partial_cmp(&self, other: &AnyDelimiterCodec) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moreimpl Eq for AnyDelimiterCodec
impl StructuralPartialEq for AnyDelimiterCodec
Auto Trait Implementations§
impl Freeze for AnyDelimiterCodec
impl RefUnwindSafe for AnyDelimiterCodec
impl Send for AnyDelimiterCodec
impl Sync for AnyDelimiterCodec
impl Unpin for AnyDelimiterCodec
impl UnwindSafe for AnyDelimiterCodec
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)