Struct cbor_data::CborBuilder

pub struct CborBuilder<'a>(_);

Builder for a single CBOR value.

Implementations

impl<'a> CborBuilder<'a>

pub fn new() -> Self

Create a builder that writes into its own fresh vector.

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

Create a builder that clears the given vector and writes into it.

You can use this to reuse a scratch space across multiple values being built, e.g. by keeping the same vector in a thread-local variable.

pub fn write_pos(self, value: u64, tag: Option<u64>) -> CborOwned

Write a unsigned value of up to 64 bits.

pub fn write_neg(self, value: u64, tag: Option<u64>) -> CborOwned

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

pub fn write_bytes(self, value: &[u8], tag: Option<u64>) -> CborOwned

Write the given slice as a definite size byte string.

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

Write the given slice as a definite size string.

pub fn write_bool(self, value: bool, tag: Option<u64>) -> CborOwned

pub fn write_null(self, tag: Option<u64>) -> CborOwned

pub fn write_undefined(self, tag: Option<u64>) -> CborOwned

pub fn write_lit(self, value: Literal, tag: Option<u64>) -> CborOwned

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

pub fn write_array(self, tag: Option<u64>) -> ArrayBuilder<'a, CborOwned>

Write an array that is then filled by the returned builder.

see trait Encoder for usage examples

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

Write an array that is then filled by the provided closure using the passed builder.

see trait Encoder for usage examples

pub fn write_dict(self, tag: Option<u64>) -> DictBuilder<'a, CborOwned>

Write a dict that is then filled by the returned builder.

see trait Encoder for usage examples

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

Write a dict that is then filled by the provided closure using the passed builder.

see trait Encoder for usage examples

pub fn encode_array<F>(self, f: F) -> CborOwned where
    F: FnMut(ArrayWriter<'_>), 

Write an array that is then filled by the provided closure using the passed builder.

see trait Encoder for usage examples

pub fn encode_dict<F>(self, f: F) -> CborOwned where
    F: FnMut(DictWriter<'_>), 

Write a dict that is then filled by the provided closure using the passed builder.

see trait Encoder for usage examples

Trait Implementations

impl Default for CborBuilder<'static>

pub fn default() -> Self

Returns the "default value" for a type.

impl<'a> Encoder for CborBuilder<'a>

type Output = CborOwned

pub unsafe fn writer(&mut self) -> ArrayWriter<'_>

Safety

pub unsafe fn finish(self) -> Self::Output

Safety

pub fn encode_u64(self, value: u64) -> Self::Output

Encode an unsigned integer of at most 64 bit.

pub fn encode_i64(self, value: i64) -> Self::Output

Encode a signed integer of at most 64 bit.

pub fn encode_f64(self, value: f64) -> Self::Output

Encode a floating-point number of at most 64 bit.