Struct futures_cbor_codec::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>

pub fn new() -> Self

Creates a new codec

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

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

pub 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<'de, Dec: Deserialize<'de>, Enc: Serialize> Default for Codec<Dec, Enc>

fn default() -> Self

Returns the "default value" for a type.

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

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

Formats the value using the given formatter.

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

type Item = Dec

The type of items returned by decode

type Error = Error

The type of decoding errors.

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

Decode an item from the src BytesMut into an item

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

type Item = Enc

The type of items consumed by encode

type Error = Error

The type of encoding errors.

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

Encodes an item into the BytesMut provided by dst.