Struct cbor_data::KeyBuilder

pub struct KeyBuilder<'a, 'b>(_);

Builder for the first step of try_write_pair

This builder can be used for exactly one item (which may be a complex one, like an array) and returns a SingleBuilder that needs to be used to write the value for this dictionary entry.

Trait Implementations

impl<'a, 'b> Writer for KeyBuilder<'a, 'b>

type Output = SingleBuilder<'a, 'b>

fn max_definite(&self) -> Option<u64>

Configured maximum array or dict length up to which definite size encoding is used.

fn set_max_definite(&mut self, max: Option<u64>)

Set the maximum array or dict length up to which definite size encoding is used.

fn write_pos(
    self,
    value: u64,
    tags: impl IntoIterator<Item = u64>
) -> Self::Output

Write a unsigned value of up to 64 bits. Tags are from outer to inner.

fn write_neg(
    self,
    value: u64,
    tags: impl IntoIterator<Item = u64>
) -> Self::Output

Write a negative value of up to 64 bits — the represented number is -1 - value. Tags are from outer to inner.

fn write_bytes(
    self,
    value: &[u8],
    tags: impl IntoIterator<Item = u64>
) -> Self::Output

Write the given slice as a definite size byte string. Tags are from outer to inner.

fn write_bytes_chunked(
    self,
    value: impl IntoIterator<Item = impl AsRef<[u8]>> + Copy,
    tags: impl IntoIterator<Item = u64>
) -> Self::Output

Write the given slices as a definite size byte string. Tags are from outer to inner.

fn write_str(
    self,
    value: &str,
    tags: impl IntoIterator<Item = u64>
) -> Self::Output

Write the given slice as a definite size string. Tags are from outer to inner.

fn write_str_chunked(
    self,
    value: impl IntoIterator<Item = impl AsRef<str>> + Copy,
    tags: impl IntoIterator<Item = u64>
) -> Self::Output

Write the given slice as a definite size string. Tags are from outer to inner.

fn write_bool(
    self,
    value: bool,
    tags: impl IntoIterator<Item = u64>
) -> Self::Output

Tags are from outer to inner.

fn write_null(self, tags: impl IntoIterator<Item = u64>) -> Self::Output

Tags are from outer to inner.

fn write_undefined(self, tags: impl IntoIterator<Item = u64>) -> Self::Output

Tags are from outer to inner.

fn write_lit(
    self,
    value: Literal,
    tags: impl IntoIterator<Item = u64>
) -> Self::Output

Write custom literal value — RFC 8949 §3.3 is required reading. Tags are from outer to inner.

fn write_array<F>(self, tags: impl IntoIterator<Item = u64>, f: F) -> Self::Outputwhere
    F: FnOnce(&mut ArrayWriter<'_>),

Write a nested array using the given closure that receives an array builder. Tags are from outer to inner.

fn write_array_ret<T, F>(
    self,
    tags: impl IntoIterator<Item = u64>,
    f: F
) -> (Self::Output, T)where
    F: FnOnce(&mut ArrayWriter<'_>) -> T,

Write a nested array using the given closure that receives an array builder. Tags are from outer to inner.

fn write_dict<F>(self, tags: impl IntoIterator<Item = u64>, f: F) -> Self::Outputwhere
    F: FnOnce(&mut DictWriter<'_>),

Write a nested dict using the given closure that receives a dict builder. Tags are from outer to inner.

fn write_dict_ret<T, F>(
    self,
    tags: impl IntoIterator<Item = u64>,
    f: F
) -> (Self::Output, T)where
    F: FnOnce(&mut DictWriter<'_>) -> T,

Write a nested dict using the given closure that receives a dict builder. Tags are from outer to inner.

fn write_canonical(self, bytes: &[u8]) -> Result<Self::Output, ParseError>

Interpret the given bytes as a single CBOR item and write it to this builder, canonicalising its contents like CborOwned::canonical()

fn write_trusting(self, bytes: &[u8]) -> Self::Output

Assume that the given bytes are a well-formed single CBOR item and write it to this builder.

fn write_item(self, item: &Cbor) -> Self::Output

Write the given CBOR item