Struct cbor_data::Cbor

pub struct Cbor<'a>(_);

Wrapper around a byte slice that allows parsing as CBOR value.

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 CborOwned::canonical constructor. In case the message was encoded for example using CborBuilder it is sufficient to use the trusting constructor.

Implementations

impl<'a> Cbor<'a>

pub fn trusting(bytes: &'a [u8]) -> Self

Wrap in Cbor for indexing.

No checks on the integrity are made, indexing methods may panic if encoded lengths are out of bound or when encountering indefinite size (byte) strings. If you want to carefully treat data obtained from unreliable sources, prefer CborOwned::canonical. The results of CborBuilder can also safely be fed to this method.

pub fn to_owned(&self) -> CborOwned

Copy the underlying bytes to create a fully owned CBOR value.

No checks on the integrity are made, indexing methods may panic if encoded lengths are out of bound or when encountering indefinite size (byte) strings. If you want to carefully treat data obtained from unreliable sources, prefer CborOwned::canonical. The results of CborBuilder can also safely be fed to this method.

impl<'a> Cbor<'a>

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

A view onto the underlying bytes

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

Extract the single value represented by this piece of CBOR

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

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<'a>>

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<Err, V: Visitor<'a, Err>>(
    &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<'a> AsRef<[u8]> for Cbor<'a>

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

Performs the conversion.

impl<'a> Debug for Cbor<'a>

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

Formats the value using the given formatter.

impl<'a> Display for Cbor<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq<Cbor<'a>> for Cbor<'a>

fn eq(&self, other: &Cbor<'a>) -> bool

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

fn ne(&self, other: &Cbor<'a>) -> bool

This method tests for !=.

impl<'a> StructuralPartialEq for Cbor<'a>