Enum ruma::CanonicalJsonValue
source · [−]pub enum CanonicalJsonValue {
Null,
Bool(bool),
Integer(Int),
String(String),
Array(Vec<CanonicalJsonValue, Global>),
Object(BTreeMap<String, CanonicalJsonValue, Global>),
}
canonical-json
only.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
sourceimpl CanonicalJsonValue
impl CanonicalJsonValue
sourcepub fn as_bool(&self) -> Option<bool>
pub fn as_bool(&self) -> Option<bool>
If the CanonicalJsonValue
is a Bool
, return the inner value.
sourcepub fn as_integer(&self) -> Option<Int>
pub fn as_integer(&self) -> Option<Int>
If the CanonicalJsonValue
is an Integer
, return the inner value.
sourcepub fn as_str(&self) -> Option<&str>
pub fn as_str(&self) -> Option<&str>
If the CanonicalJsonValue
is a String
, return a reference to the inner value.
sourcepub fn as_array(&self) -> Option<&[CanonicalJsonValue]>
pub fn as_array(&self) -> Option<&[CanonicalJsonValue]>
If the CanonicalJsonValue
is an Array
, return a reference to the inner value.
sourcepub fn as_object(&self) -> Option<&BTreeMap<String, CanonicalJsonValue, Global>>
pub fn as_object(&self) -> Option<&BTreeMap<String, CanonicalJsonValue, Global>>
If the CanonicalJsonValue
is an Object
, return a reference to the inner value.
sourcepub fn as_array_mut(&mut self) -> Option<&mut Vec<CanonicalJsonValue, Global>>
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.
sourcepub fn as_object_mut(
&mut self
) -> Option<&mut BTreeMap<String, CanonicalJsonValue, Global>>
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.
sourcepub fn is_integer(&self) -> bool
pub fn is_integer(&self) -> bool
Returns true
if the CanonicalJsonValue
is an Integer
.
Trait Implementations
sourceimpl Clone for CanonicalJsonValue
impl Clone for CanonicalJsonValue
sourcefn clone(&self) -> CanonicalJsonValue
fn clone(&self) -> CanonicalJsonValue
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresourceimpl Debug for CanonicalJsonValue
impl Debug for CanonicalJsonValue
sourceimpl Default for CanonicalJsonValue
impl Default for CanonicalJsonValue
sourcefn default() -> CanonicalJsonValue
fn default() -> CanonicalJsonValue
sourceimpl<'de> Deserialize<'de> for CanonicalJsonValue
impl<'de> Deserialize<'de> for CanonicalJsonValue
sourcefn deserialize<D>(
deserializer: D
) -> Result<CanonicalJsonValue, <D as Deserializer<'de>>::Error>where
D: Deserializer<'de>,
fn deserialize<D>(
deserializer: D
) -> Result<CanonicalJsonValue, <D as Deserializer<'de>>::Error>where
D: Deserializer<'de>,
sourceimpl Display for CanonicalJsonValue
impl Display for CanonicalJsonValue
sourcefn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>
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}
.
sourceimpl From<BTreeMap<String, CanonicalJsonValue, Global>> for CanonicalJsonValue
impl From<BTreeMap<String, CanonicalJsonValue, Global>> for CanonicalJsonValue
sourcefn from(val: BTreeMap<String, CanonicalJsonValue, Global>) -> CanonicalJsonValue
fn from(val: BTreeMap<String, CanonicalJsonValue, Global>) -> CanonicalJsonValue
sourceimpl From<CanonicalJsonValue> for Value
impl From<CanonicalJsonValue> for Value
sourcefn from(val: CanonicalJsonValue) -> Value
fn from(val: CanonicalJsonValue) -> Value
sourceimpl From<Int> for CanonicalJsonValue
impl From<Int> for CanonicalJsonValue
sourcefn from(val: Int) -> CanonicalJsonValue
fn from(val: Int) -> CanonicalJsonValue
sourceimpl From<String> for CanonicalJsonValue
impl From<String> for CanonicalJsonValue
sourcefn from(val: String) -> CanonicalJsonValue
fn from(val: String) -> CanonicalJsonValue
sourceimpl From<Vec<CanonicalJsonValue, Global>> for CanonicalJsonValue
impl From<Vec<CanonicalJsonValue, Global>> for CanonicalJsonValue
sourcefn from(val: Vec<CanonicalJsonValue, Global>) -> CanonicalJsonValue
fn from(val: Vec<CanonicalJsonValue, Global>) -> CanonicalJsonValue
sourceimpl From<bool> for CanonicalJsonValue
impl From<bool> for CanonicalJsonValue
sourcefn from(val: bool) -> CanonicalJsonValue
fn from(val: bool) -> CanonicalJsonValue
sourceimpl PartialEq<BTreeMap<String, CanonicalJsonValue, Global>> for CanonicalJsonValue
impl PartialEq<BTreeMap<String, CanonicalJsonValue, Global>> for CanonicalJsonValue
sourceimpl PartialEq<CanonicalJsonValue> for BTreeMap<String, CanonicalJsonValue, Global>
impl PartialEq<CanonicalJsonValue> for BTreeMap<String, CanonicalJsonValue, Global>
sourcefn eq(&self, other: &CanonicalJsonValue) -> bool
fn eq(&self, other: &CanonicalJsonValue) -> bool
sourceimpl PartialEq<CanonicalJsonValue> for CanonicalJsonValue
impl PartialEq<CanonicalJsonValue> for CanonicalJsonValue
sourcefn eq(&self, other: &CanonicalJsonValue) -> bool
fn eq(&self, other: &CanonicalJsonValue) -> bool
sourceimpl PartialEq<CanonicalJsonValue> for Vec<CanonicalJsonValue, Global>
impl PartialEq<CanonicalJsonValue> for Vec<CanonicalJsonValue, Global>
sourcefn eq(&self, other: &CanonicalJsonValue) -> bool
fn eq(&self, other: &CanonicalJsonValue) -> bool
sourceimpl PartialEq<Vec<CanonicalJsonValue, Global>> for CanonicalJsonValue
impl PartialEq<Vec<CanonicalJsonValue, Global>> for CanonicalJsonValue
sourceimpl Serialize for CanonicalJsonValue
impl Serialize for CanonicalJsonValue
sourcefn serialize<S>(
&self,
serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>where
S: Serializer,
fn serialize<S>(
&self,
serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>where
S: Serializer,
sourceimpl TryFrom<Value> for CanonicalJsonValue
impl TryFrom<Value> for CanonicalJsonValue
type Error = CanonicalJsonError
type Error = CanonicalJsonError
sourcefn try_from(
val: Value
) -> Result<CanonicalJsonValue, <CanonicalJsonValue as TryFrom<Value>>::Error>
fn try_from(
val: Value
) -> Result<CanonicalJsonValue, <CanonicalJsonValue as TryFrom<Value>>::Error>
impl Eq for CanonicalJsonValue
impl StructuralEq for CanonicalJsonValue
impl StructuralPartialEq for CanonicalJsonValue
Auto Trait Implementations
impl RefUnwindSafe for CanonicalJsonValue
impl Send for CanonicalJsonValue
impl Sync for CanonicalJsonValue
impl Unpin for CanonicalJsonValue
impl UnwindSafe for CanonicalJsonValue
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
sourceimpl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
sourcefn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.