Struct vector::codecs::Decoder

pub struct Decoder {
    pub framer: Framer,
    pub deserializer: Deserializer,
    pub log_namespace: LogNamespace,
}

A decoder that can decode structured events from a byte stream / byte messages.

Fields

framer: Framer

The framer being used.

deserializer: Deserializer

The deserializer being used.

log_namespace: LogNamespace

The log_namespace being used.

Implementations

impl Decoder

pub const fn new(framer: Framer, deserializer: Deserializer) -> Self

Creates a new Decoder with the specified Framer to produce byte frames from the byte stream / byte messages and Deserializer to parse structured events from a byte frame.

pub const fn with_log_namespace(self, log_namespace: LogNamespace) -> Self

Sets the log namespace that will be used when decoding.

pub fn deserializer_parse( &self, frame: Bytes, ) -> Result<(SmallVec<[Event; 1]>, usize), Error>

Parses a frame using the included deserializer, and handles any errors by logging.

Trait Implementations

impl Clone for Decoder

fn clone(&self) -> Decoder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Decoder for Decoder

type Item = (SmallVec<[Event; 1]>, usize)

The type of decoded frames.

type Error = Error

The type of unrecoverable frame decoding errors.

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

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

fn decode_eof( &mut self, buf: &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.

impl Default for Decoder

fn default() -> Self

Returns the “default value” for a type.