Enum ruma_signatures::CanonicalJsonValue[−][src]

pub enum CanonicalJsonValue {
    Null,
    Bool(bool),
    Integer(Int),
    String(String),
    Array(Vec<CanonicalJsonValue, Global>),
    Object(BTreeMap<String, CanonicalJsonValue>),
}

Expand description

Represents a canonical JSON value as per the Matrix specification.

Variants

Null

Represents a JSON null value.

let v: CanonicalJsonValue = json!(null).try_into().unwrap();

Bool(bool)

Represents a JSON boolean.

let v: CanonicalJsonValue = json!(true).try_into().unwrap();

Integer(Int)

Represents a JSON integer.

let v: CanonicalJsonValue = json!(12).try_into().unwrap();

String(String)

Represents a JSON string.

let v: CanonicalJsonValue = json!("a string").try_into().unwrap();

Array(Vec<CanonicalJsonValue, Global>)

Represents a JSON array.

let v: CanonicalJsonValue = json!(["an", "array"]).try_into().unwrap();

Object(BTreeMap<String, CanonicalJsonValue>)

Represents a JSON object.

The map is backed by a BTreeMap to guarantee the sorting of keys.

let v: CanonicalJsonValue = json!({ "an": "object" }).try_into().unwrap();

Implementations

`impl CanonicalJsonValue`[src]

`pub fn as_bool(&self) -> Option<bool>`[src]

If the CanonicalJsonValue is a Bool, return the inner value.

`pub fn as_integer(&self) -> Option<Int>`[src]

If the CanonicalJsonValue is an Integer, return the inner value.

`pub fn as_str(&self) -> Option<&str>`[src]

If the CanonicalJsonValue is a String, return a reference to the inner value.

`pub fn as_array(&self) -> Option<&[CanonicalJsonValue]>`[src]

If the CanonicalJsonValue is an Array, return a reference to the inner value.

`pub fn as_object(&self) -> Option<&BTreeMap<String, CanonicalJsonValue>>`[src]

If the CanonicalJsonValue is an Object, return a reference to the inner value.

`pub fn as_array_mut(&mut self) -> Option<&mut Vec<CanonicalJsonValue, Global>>`[src]

If the CanonicalJsonValue is an Array, return a mutable reference to the inner value.

`pub fn as_object_mut( &mut self ) -> Option<&mut BTreeMap<String, CanonicalJsonValue>>`[src]

If the CanonicalJsonValue is an Object, return a mutable reference to the inner value.

`pub fn is_bool(&self) -> bool`[src]

Returns true if the CanonicalJsonValue is a Bool.

`pub fn is_integer(&self) -> bool`[src]

Returns true if the CanonicalJsonValue is an Integer.

`pub fn is_string(&self) -> bool`[src]

Returns true if the CanonicalJsonValue is a String.

`pub fn is_array(&self) -> bool`[src]

Returns true if the CanonicalJsonValue is an Array.

`pub fn is_object(&self) -> bool`[src]

Returns true if the CanonicalJsonValue is an Object.

Trait Implementations

`impl Clone for CanonicalJsonValue`[src]

`pub fn clone(&self) -> CanonicalJsonValue`[src]

Returns a copy of the value. Read more

`fn clone_from(&mut self, source: &Self)`1.0.0 [src]

Performs copy-assignment from source. Read more

`impl Debug for CanonicalJsonValue`[src]

`pub fn fmt(&self, formatter: &mut Formatter<'_>) -> Result<(), Error>`[src]

Formats the value using the given formatter. Read more

`impl Default for CanonicalJsonValue`[src]

`pub fn default() -> CanonicalJsonValue`[src]

Returns the “default value” for a type. Read more

`impl<'de> Deserialize<'de> for CanonicalJsonValue`[src]

`pub fn deserialize<D>( deserializer: D ) -> Result<CanonicalJsonValue, <D as Deserializer<'de>>::Error> where D: Deserializer<'de>,` [src]

Deserialize this value from the given Serde deserializer. Read more

`impl Display for CanonicalJsonValue`[src]

`pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>`[src]

Display this value as a string.

This Display implementation is intentionally unaffected by any formatting parameters, because adding extra whitespace or otherwise pretty-printing it would make it not the canonical form anymore.

If you want to pretty-print a CanonicalJsonValue for debugging purposes, use one of serde_json::{to_string_pretty, to_vec_pretty, to_writer_pretty}.

`impl From<BTreeMap<String, CanonicalJsonValue>> for CanonicalJsonValue`[src]

`pub fn from(val: BTreeMap<String, CanonicalJsonValue>) -> CanonicalJsonValue`[src]

Performs the conversion.

`impl From<Int> for CanonicalJsonValue`[src]

`pub fn from(val: Int) -> CanonicalJsonValue`[src]

Performs the conversion.

`impl From<String> for CanonicalJsonValue`[src]

`pub fn from(val: String) -> CanonicalJsonValue`[src]

Performs the conversion.

`impl From<Vec<CanonicalJsonValue, Global>> for CanonicalJsonValue`[src]

`pub fn from(val: Vec<CanonicalJsonValue, Global>) -> CanonicalJsonValue`[src]

Performs the conversion.

`impl From<bool> for CanonicalJsonValue`[src]