Struct ruma::serde::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>

This is supported on crate feature api only.

Create a Raw from a boxed RawValue.

pub fn json(&self) -> &RawValue

This is supported on crate feature api only.

Access the underlying json value.

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

This is supported on crate feature api only.

Convert self into the underlying json value.

pub fn get_field<'a, U>(&'a self, field_name: &str) -> Result<Option<U>, Error> where
    U: Deserialize<'a>, 

This is supported on crate feature api only.

Try to access a given field inside this Raw, assuming it contains an object.

Returns Err(_) when the contained value is not an object, or the field exists but is fails to deserialize to the expected type.

Returns Ok(None) when the field doesn’t exist or is null.

Example

if raw_event.get_field::<String>("type")?.as_deref() == Some("org.custom.matrix.event") {
    let event = raw_event.deserialize_as::<CustomMatrixEvent>()?;
    // ...
}

pub fn deserialize<'a>(&'a self) -> Result<T, Error> where
    T: Deserialize<'a>, 

This is supported on crate feature api only.

Try to deserialize the JSON as the expected type.

pub fn deserialize_as<'a, U>(&'a self) -> Result<U, Error> where
    U: Deserialize<'a>, 

This is supported on crate feature api only.

Try to deserialize the JSON as a custom type.

Trait Implementations

impl<T> Clone for Raw<T>

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

Returns a copy of the value.

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 an event’s 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.