Struct cbor_data::DictWriter

pub struct DictWriter<'a>(_);

Builder for a dict value, used by write_dict_rec().

see trait Encoder for usage examples

Implementations

impl<'a> DictWriter<'a>

pub fn write_pos(&mut self, key: &str, value: u64, tag: Option<u64>)

Write a unsigned value of up to 64 bits.

pub fn write_neg(&mut self, key: &str, value: u64, tag: Option<u64>)

Write a negative value of up to 64 bits — the represented number is -1 - value.

pub fn write_bytes(&mut self, key: &str, value: &[u8], tag: Option<u64>)

Write the given slice as a definite size byte string.

pub fn write_str(&mut self, key: &str, value: &str, tag: Option<u64>)

Write the given slice as a definite size string.

pub fn write_bool(&mut self, key: &str, value: bool, tag: Option<u64>)

pub fn write_null(&mut self, key: &str, tag: Option<u64>)

pub fn write_undefined(&mut self, key: &str, tag: Option<u64>)

pub fn write_lit(&mut self, key: &str, value: Literal, tag: Option<u64>)

Write custom literal value — RFC 7049 §2.3 is required reading.

pub fn write_array(self, key: &str, tag: Option<u64>) -> ArrayBuilder<'a, Self>

Write a nested array that is then filled by the returned builder. You can resume building this outer dict by using the finish() method.

pub fn write_array_rec<T, F>(&mut self, key: &str, tag: Option<u64>, f: F) -> T where
    F: FnMut(ArrayWriter<'_>) -> T, 

Write a nested array using the given closure that receives an array builder.

This method is very useful for recursively building a CBOR structure without statically known recursion limit, avoiding infinite type errors.

let (cbor, _) = CborBuilder::default().write_dict_rec(None, |mut builder| {
    builder.write_array_rec("x", None, |mut builder| {
        builder.write_pos(42, None);
    });
});

pub fn write_dict(self, key: &str, tag: Option<u64>) -> DictBuilder<'a, Self>

Write a nested dict that is then filled by the returned builder. You can resume building this outer dict by using the finish() method.

pub fn write_dict_rec<T, F>(&mut self, key: &str, tag: Option<u64>, f: F) -> T where
    F: FnMut(DictWriter<'_>) -> T, 

Write a nested dict using the given closure that receives an dict builder.

This method is very useful for recursively building a CBOR structure without statically known recursion limit, avoiding infinite type errors.

let (cbor, _) = CborBuilder::default().write_dict_rec(None, |mut builder | {
    builder.write_dict_rec("x", None, |mut builder| {
        builder.write_pos("y", 42, None);
    });
});

pub fn with_key(self, key: &'a str) -> DictValueWriter<'a>

Use Encoder methods for writing an entry into the dictionary.

use cbor_data::{CborBuilder, Encoder};

let cbor = CborBuilder::default().encode_dict(|mut builder| {
    builder
        .with_key("x")
        .encode_u64(25);
});

Trait Implementations

impl<'a> From<&'a mut Vec<u8, Global>> for DictWriter<'a>

pub fn from(v: &'a mut Vec<u8>) -> Self

Performs the conversion.