Enum codecs::decoding::Framer

pub enum Framer {
    Bytes(BytesDecoder),
    CharacterDelimited(CharacterDelimitedDecoder),
    LengthDelimited(LengthDelimitedDecoder),
    NewlineDelimited(NewlineDelimitedDecoder),
    OctetCounting(OctetCountingDecoder),
    Boxed(BoxedFramer),
    ChunkedGelf(ChunkedGelfDecoder),
}

Produce byte frames from a byte stream / byte message.

Variants

Bytes(BytesDecoder)

Uses a BytesDecoder for framing.

CharacterDelimited(CharacterDelimitedDecoder)

Uses a CharacterDelimitedDecoder for framing.

LengthDelimited(LengthDelimitedDecoder)

Uses a LengthDelimitedDecoder for framing.

NewlineDelimited(NewlineDelimitedDecoder)

Uses a NewlineDelimitedDecoder for framing.

OctetCounting(OctetCountingDecoder)

Uses a OctetCountingDecoder for framing.

Boxed(BoxedFramer)

Uses an opaque Framer implementation for framing.

ChunkedGelf(ChunkedGelfDecoder)

Uses a ChunkedGelfDecoder for framing.

Trait Implementations

impl Clone for Framer

fn clone(&self) -> Framer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Framer

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

Formats the value using the given formatter.

impl Decoder for Framer

type Item = Bytes

The type of decoded frames.

type Error = Box<dyn FramingError>

The type of unrecoverable frame decoding errors.

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

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

fn decode_eof( &mut self, src: &mut BytesMut, ) -> Result<Option<Self::Item>, 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.