Struct CborValueRef 

pub struct CborValueRef<'a> { /* private fields */ }

A borrowed view into a canonical CBOR message.

The view carries the full message bytes plus a (start, end) range for the current value. All nested values returned from queries keep referencing the original message bytes.

Implementations

impl<'a> CborValueRef<'a>

pub unsafe fn from_canonical_range( data: &'a [u8], start: usize, end: usize, ) -> Self

Available on crate feature unsafe only.

Construct a value reference from a canonical byte slice and range.

Safety

The caller must ensure data is canonical CBOR and the range bounds a full CBOR item.

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

Returns the raw bytes (canonical CBOR encoding) for this value.

pub const fn offset(self) -> usize

Returns the starting offset (in bytes) of this value within the message.

pub const fn len(self) -> usize

Returns the byte length of this value’s canonical encoding.

pub const fn is_empty(self) -> bool

Returns whether this value’s canonical encoding is empty.

pub fn kind(self) -> Result<CborKind, CborError>

Returns the kind of this value.

Errors

Returns CborError if the underlying bytes are malformed.

pub fn is_null(self) -> bool

Returns true if this value is CBOR null.

pub fn map(self) -> Result<MapRef<'a>, CborError>

Interprets this value as a CBOR map and returns a borrowed map view.

Errors

Returns CborError::ExpectedMap if the value is not a map.

pub fn array(self) -> Result<ArrayRef<'a>, CborError>

Interprets this value as a CBOR array and returns a borrowed array view.

Errors

Returns CborError::ExpectedArray if the value is not an array.

pub fn get_key(self, key: &str) -> Result<Option<Self>, CborError>

Retrieves a value by map key from this value (which must be a map).

Errors

Returns CborError::ExpectedMap if the value is not a map.

pub fn get_index(self, index: usize) -> Result<Option<Self>, CborError>

Retrieves a value by array index from this value (which must be an array).

Errors

Returns CborError::ExpectedArray if the value is not an array.

pub fn at(self, path: &[PathElem<'_>]) -> Result<Option<Self>, CborError>

Traverses a nested path starting from this value.

Returns Ok(None) if any map key is missing or any array index is out of bounds. Returns Err(_) on type mismatches or malformed canonical input.

Errors

Returns CborError for type mismatches or malformed canonical input.

pub fn integer(self) -> Result<CborIntegerRef<'a>, CborError>

Decodes this value as a CBOR integer (safe or bignum).

Errors

Returns CborError::ExpectedInteger if the value is not an integer or is malformed.

pub fn text(self) -> Result<&'a str, CborError>

Decodes this value as a CBOR text string.

Errors

Returns CborError::ExpectedText if the value is not a text string or is malformed.

pub fn bytes(self) -> Result<&'a [u8], CborError>

Decodes this value as a CBOR byte string.

Errors

Returns CborError::ExpectedBytes if the value is not a byte string or is malformed.

pub fn bool(self) -> Result<bool, CborError>

Decodes this value as a CBOR boolean.

Errors

Returns CborError::ExpectedBool if the value is not a boolean or is malformed.

pub fn float64(self) -> Result<f64, CborError>

Decodes this value as a CBOR float64.

Errors

Returns CborError::ExpectedFloat if the value is not a float64 or is malformed.

Trait Implementations

impl<'de> CborDecode<'de> for CborValueRef<'de>

fn decode<const CHECKED: bool>( decoder: &mut Decoder<'de, CHECKED>, ) -> Result<Self, CborError>

Decode Self from a streaming decoder.

impl CborEncode for CborValueRef<'_>

Available on crate feature alloc only.

fn encode(&self, enc: &mut Encoder) -> Result<(), CborError>

Encode self into the provided encoder.

impl<'a> Clone for CborValueRef<'a>

fn clone(&self) -> CborValueRef<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for CborValueRef<'a>

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CborValueRef<'de>

Available on crate feature serde only.

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CborValueRef<'_>

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl CborArrayElem for CborValueRef<'_>

Available on crate feature alloc only.

impl<'a> Copy for CborValueRef<'a>

impl Eq for CborValueRef<'_>