Struct futures_cbor_codec::Encoder

pub struct Encoder<Item> { /* fields omitted */ }

CBOR based encoder.

This encoder can be used with future_codec’s FramedWrite to encode CBOR frames. Anything that is serdes Serialize can be encoded this way (at least in theory, some values return errors when attempted to serialize).

Implementations

impl<Item: Serialize> Encoder<Item>

pub fn new() -> Self

Creates a new encoder.

By default, it doesn’t do packed encoding (it includes struct field names) and it doesn’t prefix the frames with self-describe tag.

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

Turns the encoder into one with configured self-describe behaviour.

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

Turns the 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<Item: Clone> Clone for Encoder<Item>

fn clone(&self) -> Encoder<Item>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Item: Debug> Debug for Encoder<Item>

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

Formats the value using the given formatter.

impl<Item: Serialize> Default for Encoder<Item>

fn default() -> Self

Returns the “default value” for a type.

impl<Item: Serialize> Encoder for Encoder<Item>

type Item = Item

The type of items consumed by encode

type Error = Error

The type of encoding errors.

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

Encodes an item into the BytesMut provided by dst.