Struct Encoder 

pub struct Encoder { /* private fields */ }

Available on crate feature alloc only.

Streaming encoder that writes canonical CBOR directly into a Vec<u8>.

This supports splicing validated canonical bytes.

Implementations

impl Encoder

pub const fn new() -> Self

Create a new canonical encoder.

pub fn with_capacity(capacity: usize) -> Self

Create a canonical encoder with pre-allocated capacity.

pub fn len(&self) -> usize

Return the number of bytes written so far.

pub fn is_empty(&self) -> bool

Returns true if no bytes have been written.

pub fn into_vec(self) -> Vec<u8>

Consume and return the encoded bytes.

pub fn into_canonical(self) -> Result<CanonicalCbor, CborError>

Consume and return canonical bytes as a CanonicalCbor.

Errors

Returns an error if the buffer does not contain exactly one canonical CBOR item.

pub fn clear(&mut self)

Clear the encoder while retaining allocated capacity.

pub fn as_bytes(&self) -> &[u8]

Borrow the bytes emitted so far.

pub fn null(&mut self) -> Result<(), CborError>

Encode CBOR null.

Errors

Returns an error if writing to the underlying buffer fails.

pub fn bool(&mut self, v: bool) -> Result<(), CborError>

Encode a CBOR boolean.

Errors

Returns an error if writing to the underlying buffer fails.

pub fn int(&mut self, v: i64) -> Result<(), CborError>

Encode a safe-range integer.

Errors

Returns an error if the integer is outside the safe range or if encoding fails.

pub fn int_u128(&mut self, v: u128) -> Result<(), CborError>

Encode an unsigned integer, using a bignum when outside the safe range.

Errors

Returns an error if encoding fails or allocation for the bignum magnitude fails.

pub fn int_i128(&mut self, v: i128) -> Result<(), CborError>

Encode a signed integer, using a bignum when outside the safe range.

Errors

Returns an error if encoding fails or allocation for the bignum magnitude fails.

pub fn bignum( &mut self, negative: bool, magnitude: &[u8], ) -> Result<(), CborError>

Encode a CBOR bignum (tag 2/3 + byte string magnitude).

Errors

Returns an error if the magnitude is not canonical or if encoding fails.

pub fn bytes(&mut self, b: &[u8]) -> Result<(), CborError>

Encode a byte string.

Errors

Returns an error if encoding fails.

pub fn text(&mut self, s: &str) -> Result<(), CborError>

Encode a text string.

Errors

Returns an error if encoding fails.

pub fn float(&mut self, bits: F64Bits) -> Result<(), CborError>

Encode a float64 bit pattern.

Errors

Returns an error if encoding fails.

pub fn raw_cbor(&mut self, v: CanonicalCborRef<'_>) -> Result<(), CborError>

Splice already validated canonical CBOR bytes as the next value.

Errors

Returns an error if writing to the underlying buffer fails.

pub fn raw_value_ref(&mut self, v: CborValueRef<'_>) -> Result<(), CborError>

Splice a canonical sub-value reference.

Errors

Returns an error if writing to the underlying buffer fails.

pub fn array<F>(&mut self, len: usize, f: F) -> Result<(), CborError>

where F: FnOnce(&mut ArrayEncoder<'_>) -> Result<(), CborError>,

Encode a definite-length array and fill it via the provided builder.

Errors

Returns an error if encoding fails or if the builder emits a different number of items.

pub fn map<F>(&mut self, len: usize, f: F) -> Result<(), CborError>

where F: FnOnce(&mut MapEncoder<'_>) -> Result<(), CborError>,

Encode a definite-length map and fill it via the provided builder.

Errors

Returns an error if encoding fails or if the builder emits a different number of entries.

Trait Implementations

impl Default for Encoder

fn default() -> Self

Returns the “default value” for a type.