Enum matrix_sdk_base::ruma::CanonicalJsonValue

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

Available on crate feature canonical-json only.

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>)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

pub fn is_bool(&self) -> bool

Returns true if the CanonicalJsonValue is a Bool.

pub fn is_integer(&self) -> bool

Returns true if the CanonicalJsonValue is an Integer.

pub fn is_string(&self) -> bool

Returns true if the CanonicalJsonValue is a String.

pub fn is_array(&self) -> bool

Returns true if the CanonicalJsonValue is an Array.

pub fn is_object(&self) -> bool

Returns true if the CanonicalJsonValue is an Object.

Trait Implementations

impl Clone for CanonicalJsonValue

fn clone(&self) -> CanonicalJsonValue

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CanonicalJsonValue

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

Formats the value using the given formatter.

impl Default for CanonicalJsonValue

fn default() -> CanonicalJsonValue

Returns the “default value” for a type.

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

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for CanonicalJsonValue

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

impl From<&str> for CanonicalJsonValue

fn from(val: &str) -> CanonicalJsonValue

Converts to this type from the input type.

impl From<BTreeMap<String, CanonicalJsonValue>> for CanonicalJsonValue

fn from(val: BTreeMap<String, CanonicalJsonValue>) -> CanonicalJsonValue

Converts to this type from the input type.

impl From<CanonicalJsonValue> for Value

fn from(val: CanonicalJsonValue) -> Value

Converts to this type from the input type.

impl From<Int> for CanonicalJsonValue

fn from(val: Int) -> CanonicalJsonValue

Converts to this type from the input type.

impl From<String> for CanonicalJsonValue

fn from(val: String) -> CanonicalJsonValue

Converts to this type from the input type.

impl From<UInt> for CanonicalJsonValue

fn from(value: UInt) -> CanonicalJsonValue

Converts to this type from the input type.

impl From<Vec<CanonicalJsonValue>> for CanonicalJsonValue

fn from(val: Vec<CanonicalJsonValue>) -> CanonicalJsonValue

Converts to this type from the input type.

impl From<bool> for CanonicalJsonValue

fn from(val: bool) -> CanonicalJsonValue

Converts to this type from the input type.

impl PartialEq<&str> for CanonicalJsonValue

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

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

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

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

impl PartialEq<BTreeMap<String, CanonicalJsonValue>> for CanonicalJsonValue

fn eq(&self, other: &BTreeMap<String, CanonicalJsonValue>) -> bool

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

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

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

impl PartialEq<CanonicalJsonValue> for &str

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

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

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

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

impl PartialEq<CanonicalJsonValue> for BTreeMap<String, CanonicalJsonValue>

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

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

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

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

impl PartialEq<CanonicalJsonValue> for Int

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

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

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

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

impl PartialEq<CanonicalJsonValue> for String

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

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

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

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

impl PartialEq<CanonicalJsonValue> for Vec<CanonicalJsonValue>

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

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

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

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

impl PartialEq<Int> for CanonicalJsonValue

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

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

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

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

impl PartialEq<String> for CanonicalJsonValue

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

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

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

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

impl PartialEq<Vec<CanonicalJsonValue>> for CanonicalJsonValue

fn eq(&self, other: &Vec<CanonicalJsonValue>) -> bool

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

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

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

impl PartialEq<bool> for CanonicalJsonValue

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

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

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

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

impl PartialEq for CanonicalJsonValue

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

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

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

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

impl Serialize for CanonicalJsonValue

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<Value> for CanonicalJsonValue

type Error = CanonicalJsonError

The type returned in the event of a conversion error.

fn try_from( val: Value, ) -> Result<CanonicalJsonValue, <CanonicalJsonValue as TryFrom<Value>>::Error>

Performs the conversion.

impl Eq for CanonicalJsonValue

impl StructuralPartialEq for CanonicalJsonValue