95 lines
2.9 KiB
Rust
95 lines
2.9 KiB
Rust
//! Types for custom events outside of the Matrix specification.
|
|
|
|
use ruma_identifiers::RoomVersionId;
|
|
use serde::Serialize;
|
|
use serde_json::{value::RawValue as RawJsonValue, Value as JsonValue};
|
|
|
|
use crate::{
|
|
BasicEventContent, EphemeralRoomEventContent, EventContent, HasDeserializeFields,
|
|
MessageEventContent, RedactedEventContent, RedactedMessageEventContent,
|
|
RedactedStateEventContent, RoomEventContent, StateEventContent,
|
|
};
|
|
|
|
/// A custom event's type and `content` JSON object.
|
|
#[derive(Clone, Debug, Serialize)]
|
|
pub struct CustomEventContent {
|
|
/// The event type string.
|
|
#[serde(skip)]
|
|
pub event_type: String,
|
|
|
|
/// The actual `content` JSON object.
|
|
#[serde(flatten)]
|
|
pub json: JsonValue,
|
|
}
|
|
|
|
impl CustomEventContent {
|
|
/// Transforms the full event content into a redacted content according to spec.
|
|
pub fn redact(self, _: RoomVersionId) -> RedactedCustomEventContent {
|
|
RedactedCustomEventContent { event_type: self.event_type }
|
|
}
|
|
}
|
|
|
|
impl EventContent for CustomEventContent {
|
|
fn event_type(&self) -> &str {
|
|
&self.event_type
|
|
}
|
|
|
|
fn from_parts(event_type: &str, content: Box<RawJsonValue>) -> Result<Self, serde_json::Error> {
|
|
let json = serde_json::from_str(content.get())?;
|
|
Ok(Self { event_type: event_type.to_string(), json })
|
|
}
|
|
}
|
|
|
|
// A custom event must satisfy all of the event content marker traits since
|
|
// they can be used for any event kind.
|
|
impl RoomEventContent for CustomEventContent {}
|
|
|
|
impl BasicEventContent for CustomEventContent {}
|
|
|
|
impl EphemeralRoomEventContent for CustomEventContent {}
|
|
|
|
impl MessageEventContent for CustomEventContent {}
|
|
|
|
impl StateEventContent for CustomEventContent {}
|
|
|
|
/// A custom event that has been redacted.
|
|
#[derive(Clone, Debug, Serialize)]
|
|
pub struct RedactedCustomEventContent {
|
|
// This field is marked skipped but will be present because deserialization
|
|
// passes the `type` field of the JSON event to the events `EventContent::from_parts` method.
|
|
/// The event type string for this custom event "m.whatever".
|
|
#[serde(skip)]
|
|
pub event_type: String,
|
|
}
|
|
|
|
impl EventContent for RedactedCustomEventContent {
|
|
fn event_type(&self) -> &str {
|
|
&self.event_type
|
|
}
|
|
|
|
fn from_parts(
|
|
event_type: &str,
|
|
_content: Box<RawJsonValue>,
|
|
) -> Result<Self, serde_json::Error> {
|
|
Ok(Self { event_type: event_type.to_string() })
|
|
}
|
|
}
|
|
|
|
impl RedactedEventContent for RedactedCustomEventContent {
|
|
fn empty(event_type: &str) -> Result<Self, serde_json::Error> {
|
|
Ok(Self { event_type: event_type.to_string() })
|
|
}
|
|
|
|
fn has_serialize_fields(&self) -> bool {
|
|
false
|
|
}
|
|
|
|
fn has_deserialize_fields() -> HasDeserializeFields {
|
|
HasDeserializeFields::False
|
|
}
|
|
}
|
|
|
|
impl RedactedMessageEventContent for RedactedCustomEventContent {}
|
|
|
|
impl RedactedStateEventContent for RedactedCustomEventContent {}
|