Struct matrix_sdk_common::Raw

pub struct Raw<T> { /* fields omitted */ }

A wrapper around Box<RawValue>, to be used in place of any type in the Matrix endpoint definition to allow request and response types to contain that said type represented by the generic argument Ev.

Ruma offers the Raw wrapper to enable passing around JSON text that is only partially validated. This is useful when a client receives events that do not follow the spec perfectly or a server needs to generate reference hashes with the original canonical JSON string. All event structs and enums implement Serialize / Deserialize, Raw should be used to pass around events in a lossless way.

let json = r#"{ "type": "imagine a full event", "content": {...} }"#;

let deser = serde_json::from_str::<Raw<AnyRoomEvent>>(json)
    .unwrap() // the first Result from serde_json::from_str, will not fail
    .deserialize() // deserialize to the inner type
    .unwrap(); // finally get to the AnyRoomEvent

Implementations

impl<T> Raw<T>

pub fn from_json(raw: Box<RawValue, Global>) -> Raw<T>

Create a Raw from a boxed RawValue.

pub fn json(&self) -> &RawValue

Access the underlying json value.

pub fn into_json(self) -> Box<RawValue, Global>

Convert self into the underlying json value.

impl<T> Raw<T> where
    T: DeserializeOwned, 

pub fn deserialize(&self) -> Result<T, Error>

Try to deserialize the JSON into the expected type.

Trait Implementations

impl<T> Clone for Raw<T>

pub fn clone(&self) -> Raw<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Raw<T>

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for Raw<T>

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

Deserialize this value from the given Serde deserializer.

impl<'_, T> From<&'_ T> for Raw<T> where
    T: Serialize, 

pub fn from(val: &T) -> Raw<T>

Performs the conversion.

impl<T> From<T> for Raw<T> where
    T: Serialize, 

pub fn from(val: T) -> Raw<T>

Performs the conversion.

impl<T> RawExt<T> for Raw<T> where
    T: EventContent, 

pub fn deserialize_content(self, event_type: &str) -> Result<T, Error>

Try to deserialize the JSON as event content

impl<T> Serialize for Raw<T>

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