Skip to main content

Value

Enum Value 

Source
#[non_exhaustive]
pub enum Value { Uint(u64), Nint(u64), Bytes(Vec<u8>), Text(String), Array(Vec<Value>), Map(BTreeMap<String, Value>), Bool(bool), Null, }
Expand description

A value in the deterministic CBOR profile.

There is deliberately no float variant and no tag variant: the profile admits neither, so they are unrepresentable rather than rejected later. Maps are BTreeMap so that encoding is sorted by construction.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Uint(u64)

A non-negative integer (CBOR major type 0).

§

Nint(u64)

A negative integer, stored as -1 - n (CBOR major type 1).

§

Bytes(Vec<u8>)

A byte string (CBOR major type 2).

§

Text(String)

A text string, valid UTF-8 in NFC (CBOR major type 3).

§

Array(Vec<Value>)

An array (CBOR major type 4).

§

Map(BTreeMap<String, Value>)

A map with text keys, ordered by UTF-8 bytes (CBOR major type 5).

§

Bool(bool)

false, true, or null (CBOR major type 7, simple values).

§

Null

The null simple value.

Implementations§

Source§

impl Value

Source

pub fn get(&self, key: &str) -> Option<&Value>

Borrow a map entry, if this is a map containing key.

§Example
use publet_core::cbor::{Value, decode};

let value = decode(&[0xa1, 0x61, b'a', 0x01])?; // {"a": 1}
assert_eq!(value.get("a"), Some(&Value::Uint(1)));
assert_eq!(value.get("b"), None);
// Not a map, so there is nothing to get.
assert_eq!(Value::Uint(1).get("a"), None);
Source

pub fn as_text(&self) -> Option<&str>

Borrow the text, if this is a text string.

§Example
use publet_core::cbor::Value;

assert_eq!(Value::Text("hello".into()).as_text(), Some("hello"));
assert_eq!(Value::Uint(1).as_text(), None);
Source

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

Borrow the bytes, if this is a byte string.

§Example
use publet_core::cbor::Value;

assert_eq!(Value::Bytes(vec![1, 2]).as_bytes(), Some(&[1u8, 2][..]));
assert_eq!(Value::Text("hello".into()).as_bytes(), None);
Source

pub fn as_uint(&self) -> Option<u64>

The value, if this is a non-negative integer.

§Example
use publet_core::cbor::Value;

assert_eq!(Value::Uint(7).as_uint(), Some(7));
// -1 is a negative integer, not a non-negative one.
assert_eq!(Value::Nint(0).as_uint(), None);

Trait Implementations§

Source§

impl Clone for Value

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Value

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for Value

Source§

impl PartialEq for Value

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Value

Auto Trait Implementations§

§

impl Freeze for Value

§

impl RefUnwindSafe for Value

§

impl Send for Value

§

impl Sync for Value

§

impl Unpin for Value

§

impl UnsafeUnpin for Value

§

impl UnwindSafe for Value

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.