Enum ruma::serde::CanonicalJsonValue

source · [−]

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

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, Global>)`

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

source

impl CanonicalJsonValue

source

pub fn as_bool(&self) -> Option<bool>

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

source

pub fn as_integer(&self) -> Option<Int>

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

source

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

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

source

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

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

source

pub fn as_object(&self) -> Option<&BTreeMap<String, CanonicalJsonValue, Global>>

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

source

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

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

source

pub fn as_object_mut(
&mut self
) -> Option<&mut BTreeMap<String, CanonicalJsonValue, Global>>

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

source

pub fn is_bool(&self) -> bool

Returns true if the CanonicalJsonValue is a Bool.

source

pub fn is_integer(&self) -> bool

Returns true if the CanonicalJsonValue is an Integer.

source

pub fn is_string(&self) -> bool

Returns true if the CanonicalJsonValue is a String.

source

pub fn is_array(&self) -> bool

Returns true if the CanonicalJsonValue is an Array.

source

pub fn is_object(&self) -> bool

Returns true if the CanonicalJsonValue is an Object.

Trait Implementations

source

impl Clone for CanonicalJsonValue

source

fn clone(&self) -> CanonicalJsonValue

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for CanonicalJsonValue

source

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

Formats the value using the given formatter. Read more

source

impl Default for CanonicalJsonValue

source

fn default() -> CanonicalJsonValue

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

source

impl<'de> Deserialize<'de> for CanonicalJsonValue

source

fn deserialize<D>(
deserializer: D
) -> Result<CanonicalJsonValue, <D as Deserializer<'de>>::Error> where
D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

source

impl Display for CanonicalJsonValue

source

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

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}.

source