pub enum CanonicalJsonValue {
    Null,
    Bool(bool),
    Integer(Int),
    String(String),
    Array(Vec<CanonicalJsonValue>),
    Object(CanonicalJsonObject),
}
Available on crate feature 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>)

Represents a JSON array.

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

Object(CanonicalJsonObject)

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

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

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

source

pub fn as_object_mut(&mut self) -> Option<&mut CanonicalJsonObject>

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

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

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§

impl From<&str> for CanonicalJsonValue

source§

fn from(val: &str) -> Self

Converts to this type from the input type.
source§

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

source§

fn from(val: CanonicalJsonObject) -> Self

Converts to this type from the input type.
source§

impl From<CanonicalJsonValue> for Value

source§

fn from(val: CanonicalJsonValue) -> Self

Converts to this type from the input type.
source§

impl From<Int> for CanonicalJsonValue

source§

fn from(val: Int) -> Self

Converts to this type from the input type.
source§

impl From<String> for CanonicalJsonValue

source§

fn from(val: String) -> Self

Converts to this type from the input type.
source§

impl From<UInt> for CanonicalJsonValue

source§

fn from(value: UInt) -> Self

Converts to this type from the input type.
source§

impl From<Vec<CanonicalJsonValue>> for CanonicalJsonValue

source§

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

Converts to this type from the input type.
source§

impl From<bool> for CanonicalJsonValue

source§

fn from(val: bool) -> Self

Converts to this type from the input type.
source§

impl PartialEq<&str> for CanonicalJsonValue

source§

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

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

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.
source§

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

source§

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

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

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.
source§

impl PartialEq<CanonicalJsonValue> for &str

source§

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

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

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.
source§

impl PartialEq<CanonicalJsonValue> for CanonicalJsonObject

source§

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

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

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.
source§

impl PartialEq<CanonicalJsonValue> for Int

source§

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

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

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.
source§

impl PartialEq<CanonicalJsonValue> for String

source§

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

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

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.
source§

impl PartialEq<CanonicalJsonValue> for Vec<CanonicalJsonValue>

source§

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

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

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.
source§

impl PartialEq<CanonicalJsonValue> for bool

source§

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

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

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.
source§

impl PartialEq<Int> for CanonicalJsonValue

source§

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

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

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.
source§

impl PartialEq<String> for CanonicalJsonValue

source§

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

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

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.
source§

impl PartialEq<Vec<CanonicalJsonValue>> for CanonicalJsonValue

source§

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

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

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.
source§

impl PartialEq<bool> for CanonicalJsonValue

source§

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

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

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.
source§

impl PartialEq for CanonicalJsonValue

source§

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

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

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.
source§

impl Serialize for CanonicalJsonValue

source§

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

Serialize this value into the given Serde serializer. Read more
source§

impl TryFrom<Value> for CanonicalJsonValue

§

type Error = CanonicalJsonError

The type returned in the event of a conversion error.
source§

fn try_from(val: JsonValue) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl Eq for CanonicalJsonValue

source§

impl StructuralPartialEq for CanonicalJsonValue

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

§

const WITNESS: W = W::MAKE

A constant of the type witness
§

impl<T> Identity for T
where T: ?Sized,

§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,