Struct cbor_data::CborOwned

pub struct CborOwned(_);

Wrapper around a vector of bytes, for parsing as CBOR.

For details on the format see RFC 7049.

When interpreting CBOR messages from the outside (e.g. from the network) it is advisable to ingest those using the canonical constructor. In case the message was encoded for example using CborBuilder it is sufficient to use the trusting constructor.

Canonicalisation rqeuires an intermediary data buffer, which can be supplied (and reused) by the caller to save on allocations.

Implementations

impl CborOwned

pub fn trusting(bytes: impl Into<Vec<u8>>) -> Self

Copy the bytes and wrap for indexing.

No checks on the integrity are made, indexing methods may panic if encoded lengths are out of bound. If you want to carefully treat data obtained from unreliable sources, prefer canonical().

pub fn canonical(bytes: impl AsRef<[u8]>) -> Option<Self>

Copy the bytes while checking for integrity and replacing indefinite (byte) strings with definite ones.

This constructor will go through and decode the whole provided CBOR bytes and write them into a vector, thereby

• retaining only innermost tags
• writing arrays and dicts using indefinite size format
• writing numbers in their smallest form

For more configuration options like reusing a scratch space or preferring definite size encoding see CborBuilder.

pub fn borrow(&self) -> Cbor<'_>

Borrow the underlying bytes for Cbor interpretation.

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

A view onto the underlying bytes.

pub fn value(&self) -> Option<CborValue<'_>>

Extract the single value represented by this piece of CBOR.

pub fn index(&self, path: &str) -> Option<CborValue<'_>>

Extract a value by indexing into arrays and dicts, with path elements separated by dot.

Returns None if an index doesn’t exist or the indexed object is neither an array nor a dict. When the object under consideration is an array, the next path element must represent an integer number.

The empty string will yield the same as calling value(). If path elements may contain . then use index_iter().

pub fn index_iter<'b>(
    &self,
    path: impl IntoIterator<Item = &'b str>
) -> Option<CborValue<'_>>

Extract a value by indexing into arrays and dicts, with path elements yielded by an iterator.

Returns None if an index doesn’t exist or the indexed object is neither an array nor a dict. When the object under consideration is an array, the next path element must represent an integer number.

The empty iterator will yield the same as calling value().

pub fn visit<'a, Err, V: Visitor<'a, Err>>(
    &'a self,
    visitor: &mut V
) -> Result<bool, Err>

Visit the interesting parts of this CBOR item as guided by the given Visitor.

Returns false if the visit was not even begun due to invalid or non-canonical CBOR.

Trait Implementations

impl AsRef<[u8]> for CborOwned

fn as_ref(&self) -> &[u8]

Performs the conversion.

impl Clone for CborOwned

fn clone(&self) -> CborOwned

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CborOwned

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

Formats the value using the given formatter.

impl Display for CborOwned

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

Formats the value using the given formatter.

impl PartialEq<CborOwned> for CborOwned

fn eq(&self, other: &CborOwned) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &CborOwned) -> bool

This method tests for !=.

impl StructuralPartialEq for CborOwned