Struct CborCodec

pub struct CborCodec<T> { /* private fields */ }

Implementation of the tokio codec traits to encode- and decode CBOR data as a stream.

CBOR allows message framing based on initial “headers” for each “data item”, which indicate the type of data and the expected “body” length to be followed. A stream-based decoder can attempt parsing these headers and then reason about if it has enough information to proceed.

Read more on CBOR in streaming applications here: https://www.rfc-editor.org/rfc/rfc8949.html#section-5.1

Implementations

impl<M> CborCodec<M>

pub fn new() -> Self

Trait Implementations

impl<T: Clone> Clone for CborCodec<T>

fn clone(&self) -> CborCodec<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for CborCodec<T>

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

Formats the value using the given formatter.

impl<T> Decoder for CborCodec<T>

where T: Serialize + DeserializeOwned,

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

CBOR decoder method taking as an argument the bytes that have been read so far; when called, it will be in one of the following situations:

1. The buffer contains less than a full frame.
2. The buffer contains exactly a full frame.
3. The buffer contains more than a full frame.

type Item = T

The type of decoded frames.

type Error = SyncError

The type of unrecoverable frame decoding errors.

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<M> Default for CborCodec<M>

fn default() -> Self

Returns the “default value” for a type.

impl<T> Encoder<T> for CborCodec<T>

where T: Serialize,

fn encode(&mut self, item: T, dst: &mut BytesMut) -> Result<(), Self::Error>

Encodes a serializable item into CBOR bytes and adds them to the buffer.

type Error = SyncError

The type of encoding errors.