Enum serde_cbor::Value

[−] Show declaration

pub enum Value {
    Null,
    Bool(bool),
    Integer(i128),
    Float(f64),
    Bytes(Vec<u8>),
    Text(String),
    Array(Vec<Value>),
    Map(BTreeMap<Value, Value>),
    Tag(u64, Box<Value>),
    // some variants omitted
}

[−] Expand description

The Value enum, a loosely typed way of representing any valid CBOR value.

Maps are sorted according to the canonical ordering described in RFC 7049 bis. Therefore values are unambiguously serialized to a canonical form of CBOR from the same RFC.

Variants

Null

[−] Expand description

Represents the absence of a value or the value undefined.

Bool(bool)

[−] Expand description

Represents a boolean value.

Integer(i128)

[−] Expand description

Integer CBOR numbers.

The biggest value that can be represented is 2^64 - 1. While the smallest value is -2^64. Values outside this range can’t be serialized and will cause an error.

Float(f64)

[−] Expand description

Represents a floating point value.

Bytes(Vec<u8>)

[−] Expand description

Represents a byte string.

Text(String)

[−] Expand description

Represents an UTF-8 encoded string.

Array(Vec<Value>)

[−] Expand description

Represents an array of values.

Map(BTreeMap<Value, Value>)

[−] Expand description

Represents a map.

Maps are also called tables, dictionaries, hashes, or objects (in JSON). While any value can be used as a CBOR key it is better to use only one type of key in a map to avoid ambiguity. If floating point values are used as keys they are compared bit-by-bit for equality. If arrays or maps are used as keys the comparisons to establish canonical order may be slow and therefore insertion and retrieval of values will be slow too.

Tag(u64, Box<Value>)

[−] Expand description

Represents a tagged value

Trait Implementations

impl Clone for Value[+]

[+] Show hidden undocumented items

fn clone(&self) -> Value[−]

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Value[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Value[+]

[+] Show hidden undocumented items

fn deserialize<D>(deserializer: D) -> Result<Value, D::Error> where
    D: Deserializer<'de>, [−]

Deserialize this value from the given Serde deserializer.

impl Eq for Value

impl From<BTreeMap<Value, Value>> for Value[+]

[+] Show hidden undocumented items

fn from(v: BTreeMap<Value, Value>) -> Value[−]

Performs the conversion.

impl From<String> for Value[+]

[+] Show hidden undocumented items

fn from(v: String) -> Value[−]

Performs the conversion.

impl From<Vec<Value, Global>> for Value[+]

[+] Show hidden undocumented items

fn from(v: Vec<Value>) -> Value[−]

Performs the conversion.

impl From<Vec<u8, Global>> for Value[+]

[+] Show hidden undocumented items

fn from(v: Vec<u8>) -> Value[−]

Performs the conversion.

impl From<bool> for Value[+]

[+] Show hidden undocumented items

fn from(v: bool) -> Value[−]

Performs the conversion.

impl From<f32> for Value[+]

[+] Show hidden undocumented items

fn from(v: f32) -> Value[−]

Performs the conversion.

impl From<f64> for Value[+]

[+] Show hidden undocumented items

fn from(v: f64) -> Value[−]

Performs the conversion.

impl From<i16> for Value[+]

[+] Show hidden undocumented items

fn from(v: i16) -> Value[−]

Performs the conversion.

impl From<i32> for Value[+]

[+] Show hidden undocumented items

fn from(v: i32) -> Value[−]

Performs the conversion.

impl From<i64> for Value[+]

[+] Show hidden undocumented items

fn from(v: i64) -> Value[−]

Performs the conversion.

impl From<i8> for Value[+]

[+] Show hidden undocumented items

fn from(v: i8) -> Value[−]

Performs the conversion.

impl From<u16> for Value[+]

[+] Show hidden undocumented items

fn from(v: u16) -> Value[−]

Performs the conversion.

impl From<u32> for Value[+]

[+] Show hidden undocumented items

fn from(v: u32) -> Value[−]

Performs the conversion.

impl From<u64> for Value[+]

[+] Show hidden undocumented items

fn from(v: u64) -> Value[−]

Performs the conversion.

impl From<u8> for Value[+]

[+] Show hidden undocumented items

fn from(v: u8) -> Value[−]

Performs the conversion.

impl Ord for Value[+]

[+] Show hidden undocumented items

fn cmp(&self, other: &Value) -> Ordering[−]

This method returns an Ordering between self and other.

[+] Expand attributes

#[must_use]pub fn max(self, other: Self) -> Self[−]

Compares and returns the maximum of two values.

[+] Expand attributes

#[must_use]pub fn min(self, other: Self) -> Self[−]

Compares and returns the minimum of two values.

[+] Expand attributes

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self[−]

Restrict a value to a certain interval.

impl PartialEq<Value> for Value[+]

[+] Show hidden undocumented items

fn eq(&self, other: &Value) -> bool[−]

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

[+] Expand attributes

#[must_use]pub fn ne(&self, other: &Rhs) -> bool[−]

This method tests for !=.

impl PartialOrd<Value> for Value[+]

[+] Show hidden undocumented items

fn partial_cmp(&self, other: &Value) -> Option<Ordering>[−]

This method returns an ordering between self and other values if one exists.

[+] Expand attributes

#[must_use]pub fn lt(&self, other: &Rhs) -> bool[−]

This method tests less than (for self and other) and is used by the < operator.

[+] Expand attributes

#[must_use]pub fn le(&self, other: &Rhs) -> bool[−]

This method tests less than or equal to (for self and other) and is used by the <= operator.

[+] Expand attributes

#[must_use]pub fn gt(&self, other: &Rhs) -> bool[−]

This method tests greater than (for self and other) and is used by the > operator.

[+] Expand attributes

#[must_use]pub fn ge(&self, other: &Rhs) -> bool[−]

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Value[+]

[+] Show hidden undocumented items

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, [−]

Serialize this value into the given Serde serializer.