Struct cbor_data::CborOwned

pub struct CborOwned(_);

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]>,
    scratch_space: Option<&mut Vec<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

The used vector can be provided (to reuse previously allocated memory) or newly created. In the former case all contents of the provided argument will be cleared.

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.

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.

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

Trait Implementations

impl AsRef<[u8]> for CborOwned

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

Performs the conversion.

impl Clone for CborOwned

pub fn clone(&self) -> CborOwned

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CborOwned

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

Formats the value using the given formatter.

impl PartialEq<CborOwned> for CborOwned

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

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

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

This method tests for !=.

impl StructuralPartialEq for CborOwned