Struct tokio_util::codec::AnyDelimiterCodec

pub struct AnyDelimiterCodec { /* fields omitted */ }

[−] 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[−]

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.

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.

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

impl Clone for AnyDelimiterCodec[+]

[+] Show hidden undocumented items

fn clone(&self) -> AnyDelimiterCodec[−]

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl Debug for AnyDelimiterCodec[+]

[+] Show hidden undocumented items

fn fmt(&self, f: &mut Formatter<'_>) -> Result[−]

Formats the value using the given formatter.

impl Decoder for AnyDelimiterCodec[+]

[+] Show hidden undocumented items

type Item = Bytes

The type of decoded frames.

type Error = AnyDelimiterCodecError

The type of unrecoverable frame decoding errors.

fn decode(
    &mut self,
    buf: &mut BytesMut
) -> Result<Option<Bytes>, AnyDelimiterCodecError>[−]

Attempts to decode a frame from the provided buffer of bytes.

fn decode_eof(
    &mut self,
    buf: &mut BytesMut
) -> Result<Option<Bytes>, AnyDelimiterCodecError>[−]

A default method available to be called when there are no more bytes available to be read from the underlying I/O.

fn framed<T: AsyncRead + AsyncWrite + Sized>(self, io: T) -> Framed<T, Self> where
    Self: Sized, [−]

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.

impl Default for AnyDelimiterCodec[+]

[+] Show hidden undocumented items

fn default() -> Self[−]

Returns the “default value” for a type.

impl<T> Encoder<T> for AnyDelimiterCodec where
    T: AsRef<str>, [+]

[+] Show hidden undocumented items

type Error = AnyDelimiterCodecError

The type of encoding errors.

fn encode(
    &mut self,
    chunk: T,
    buf: &mut BytesMut
) -> Result<(), AnyDelimiterCodecError>[−]

Encodes a frame into the buffer provided.

impl Eq for AnyDelimiterCodec

impl Hash for AnyDelimiterCodec[+]

[+] Show hidden undocumented items

fn hash<__H: Hasher>(&self, state: &mut __H)[−]

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, [−]

Feeds a slice of this type into the given Hasher.

impl Ord for AnyDelimiterCodec[+]

[+] Show hidden undocumented items

fn cmp(&self, other: &AnyDelimiterCodec) -> Ordering[−]

This method returns an Ordering between self and other.

#[must_use]

pub fn max(self, other: Self) -> Self[−]

Compares and returns the maximum of two values.

#[must_use]

pub fn min(self, other: Self) -> Self[−]

Compares and returns the minimum of two values.

#[must_use]

pub fn clamp(self, min: Self, max: Self) -> Self[−]

Restrict a value to a certain interval.

impl PartialEq<AnyDelimiterCodec> for AnyDelimiterCodec[+]

[+] Show hidden undocumented items

fn eq(&self, other: &AnyDelimiterCodec) -> bool[−]

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &AnyDelimiterCodec) -> bool[−]

This method tests for !=.

impl PartialOrd<AnyDelimiterCodec> for AnyDelimiterCodec[+]

[+] Show hidden undocumented items

fn partial_cmp(&self, other: &AnyDelimiterCodec) -> Option<Ordering>[−]

This method returns an ordering between self and other values if one exists.

#[must_use]

pub fn lt(&self, other: &Rhs) -> bool[−]

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

pub fn le(&self, other: &Rhs) -> bool[−]

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

pub fn gt(&self, other: &Rhs) -> bool[−]

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

pub fn ge(&self, other: &Rhs) -> bool[−]

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for AnyDelimiterCodec

impl StructuralPartialEq for AnyDelimiterCodec