Struct codecs::decoding::framing::CharacterDelimitedDecoder

pub struct CharacterDelimitedDecoder {
    pub delimiter: u8,
    pub max_length: usize,
}

A decoder for handling bytes that are delimited by (a) chosen character(s).

Fields

delimiter: u8

The delimiter used to separate byte sequences.

max_length: usize

The maximum length of the byte buffer.

Implementations

impl CharacterDelimitedDecoder

pub const fn new(delimiter: u8) -> Self

Creates a CharacterDelimitedDecoder with the specified delimiter.

pub const fn new_with_max_length(delimiter: u8, max_length: usize) -> Self

Creates a CharacterDelimitedDecoder with a maximum frame length limit.

Any frames longer than max_length bytes will be discarded entirely.

pub const fn max_length(&self) -> usize

Returns the maximum frame length when decoding.

Trait Implementations

impl Clone for CharacterDelimitedDecoder

fn clone(&self) -> CharacterDelimitedDecoder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CharacterDelimitedDecoder

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

Formats the value using the given formatter.

impl Decoder for CharacterDelimitedDecoder

type Item = Bytes

The type of decoded frames.

type Error = Box<dyn FramingError>

The type of unrecoverable frame decoding errors.

fn decode(&mut self, buf: &mut BytesMut) -> Result<Option<Bytes>, Self::Error>

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

fn decode_eof( &mut self, buf: &mut BytesMut, ) -> Result<Option<Bytes>, Self::Error>

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>(self, io: T) -> Framed<T, Self>

where T: AsyncRead + AsyncWrite, 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 Hash for CharacterDelimitedDecoder

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for CharacterDelimitedDecoder

fn cmp(&self, other: &CharacterDelimitedDecoder) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for CharacterDelimitedDecoder

fn eq(&self, other: &CharacterDelimitedDecoder) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for CharacterDelimitedDecoder

fn partial_cmp(&self, other: &CharacterDelimitedDecoder) -> Option<Ordering>

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

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

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

impl Copy for CharacterDelimitedDecoder

impl Eq for CharacterDelimitedDecoder

impl StructuralPartialEq for CharacterDelimitedDecoder