Struct tokio_serde_cbor::Codec

pub struct Codec<Dec, Enc> { /* fields omitted */ }

Cbor serializer and deserializer.

This is just a combined Decoder and Encoder.

Methods

impl<'de, Dec: Deserialize<'de>, Enc: Serialize> Codec<Dec, Enc>

fn new() -> Self

Creates a new codec

fn sd(self, sd: SdMode) -> Self

Turns the internal encoder into one with confifured self-describe behaviour.

fn packed(self, packed: bool) -> Self

Turns the internal encoder into one with configured packed encoding.

If packed is true, it omits the field names from the encoded data. That makes it smaller, but it also means the decoding end must know the exact order of fields and it can't be something like python, which would want to get a dictionary out of it.

Trait Implementations

impl<Dec: Clone, Enc: Clone> Clone for Codec<Dec, Enc>

fn clone(&self) -> Codec<Dec, Enc>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Dec: Debug, Enc: Debug> Debug for Codec<Dec, Enc>

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<'de, Dec: Deserialize<'de>, Enc: Serialize> Default for Codec<Dec, Enc>

fn default() -> Self

Returns the "default value" for a type.

impl<'de, Dec: Deserialize<'de>, Enc: Serialize> IoDecoder for Codec<Dec, Enc>

type Item = Dec

The type of decoded frames.

type Error = CborError

The type of unrecoverable frame decoding errors.

fn decode(&mut self, src: &mut BytesMut) -> Result<Option<Dec>, CborError>

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.

impl<'de, Dec: Deserialize<'de>, Enc: Serialize> IoEncoder for Codec<Dec, Enc>

type Item = Enc

The type of items consumed by the Encoder

type Error = CborError

The type of encoding errors.

fn encode(&mut self, item: Enc, dst: &mut BytesMut) -> Result<(), CborError>

Encodes a frame into the buffer provided.