ruma_events/lib.rs
1#![doc(html_favicon_url = "https://ruma.dev/favicon.ico")]
2#![doc(html_logo_url = "https://ruma.dev/images/logo.png")]
3//! (De)serializable types for the events in the [Matrix](https://matrix.org) specification.
4//! These types are used by other Ruma crates.
5//!
6//! All data exchanged over Matrix is expressed as an event.
7//! Different event types represent different actions, such as joining a room or sending a message.
8//! Events are stored and transmitted as simple JSON structures.
9//! While anyone can create a new event type for their own purposes, the Matrix specification
10//! defines a number of event types which are considered core to the protocol.
11//! This module contains Rust types for all of the event types defined by the specification and
12//! facilities for extending the event system for custom event types.
13//!
14//! # Core event types
15//!
16//! This module includes Rust types for all event types in the Matrix specification.
17//! To better organize the crate, these types live in separate modules with a hierarchy that matches
18//! the reverse domain name notation of the event type. For example, the `m.room.message` event
19//! lives at `ruma::events::room::message::RoomMessageEvent`. Each type's module also contains a
20//! Rust type for that event type's `content` field, and any other supporting types required by the
21//! event's other fields.
22//!
23//! # Extending Ruma with custom events
24//!
25//! For our examples we will start with a simple custom state event. `ruma_event`
26//! specifies the state event's `type` and its `kind`.
27//!
28//! ```rust
29//! use ruma_events::macros::EventContent;
30//! use serde::{Deserialize, Serialize};
31//!
32//! #[derive(Clone, Debug, Deserialize, Serialize, EventContent)]
33//! #[ruma_event(type = "org.example.event", kind = State, state_key_type = String)]
34//! pub struct ExampleContent {
35//! field: String,
36//! }
37//! ```
38//!
39//! This can be used with events structs, such as passing it into
40//! `ruma::api::client::state::send_state_event`'s `Request`.
41//!
42//! As a more advanced example we create a reaction message event. For this event we will use a
43//! [`OriginalSyncMessageLikeEvent`] struct but any [`OriginalMessageLikeEvent`] struct would work.
44//!
45//! ```rust
46//! use ruma_common::OwnedEventId;
47//! use ruma_events::{macros::EventContent, OriginalSyncMessageLikeEvent};
48//! use serde::{Deserialize, Serialize};
49//!
50//! #[derive(Clone, Debug, Deserialize, Serialize)]
51//! #[serde(tag = "rel_type")]
52//! pub enum RelatesTo {
53//! #[serde(rename = "m.annotation")]
54//! Annotation {
55//! /// The event this reaction relates to.
56//! event_id: OwnedEventId,
57//! /// The displayable content of the reaction.
58//! key: String,
59//! },
60//!
61//! /// Since this event is not fully specified in the Matrix spec
62//! /// it may change or types may be added, we are ready!
63//! #[serde(rename = "m.whatever")]
64//! Whatever,
65//! }
66//!
67//! /// The payload for our reaction event.
68//! #[derive(Clone, Debug, Deserialize, Serialize, EventContent)]
69//! #[ruma_event(type = "m.reaction", kind = MessageLike)]
70//! pub struct ReactionEventContent {
71//! #[serde(rename = "m.relates_to")]
72//! pub relates_to: RelatesTo,
73//! }
74//!
75//! let json = serde_json::json!({
76//! "content": {
77//! "m.relates_to": {
78//! "event_id": "$xxxx-xxxx",
79//! "key": "👍",
80//! "rel_type": "m.annotation"
81//! }
82//! },
83//! "event_id": "$xxxx-xxxx",
84//! "origin_server_ts": 1,
85//! "sender": "@someone:example.org",
86//! "type": "m.reaction",
87//! "unsigned": {
88//! "age": 85
89//! }
90//! });
91//!
92//! // The downside of this event is we cannot use it with event enums,
93//! // but could be deserialized from a `Raw<_>` that has failed to deserialize.
94//! assert!(matches!(
95//! serde_json::from_value::<OriginalSyncMessageLikeEvent<ReactionEventContent>>(json),
96//! Ok(OriginalSyncMessageLikeEvent {
97//! content: ReactionEventContent {
98//! relates_to: RelatesTo::Annotation { key, .. },
99//! },
100//! ..
101//! }) if key == "👍"
102//! ));
103//! ```
104
105#![warn(missing_docs)]
106
107use std::{collections::BTreeSet, fmt};
108
109use ruma_common::{EventEncryptionAlgorithm, OwnedUserId, RoomVersionId};
110use serde::{de::IgnoredAny, Deserialize, Serialize, Serializer};
111
112// Needs to be public for trybuild tests
113#[doc(hidden)]
114pub mod _custom;
115mod content;
116mod enums;
117mod kinds;
118mod state_key;
119mod unsigned;
120
121// So event macros work inside this crate.
122extern crate self as ruma_events;
123
124/// Re-exports used by macro-generated code.
125///
126/// It is not considered part of this module's public API.
127#[doc(hidden)]
128pub mod exports {
129 pub use ruma_common;
130 pub use ruma_macros;
131 pub use serde;
132 pub use serde_json;
133}
134
135/// Re-export of all the derives needed to create your own event types.
136pub mod macros {
137 pub use ruma_macros::{Event, EventContent};
138}
139
140#[cfg(feature = "unstable-msc3927")]
141pub mod audio;
142#[cfg(feature = "unstable-msc3489")]
143pub mod beacon;
144#[cfg(feature = "unstable-msc3489")]
145pub mod beacon_info;
146pub mod call;
147pub mod direct;
148pub mod dummy;
149#[cfg(feature = "unstable-msc3954")]
150pub mod emote;
151#[cfg(feature = "unstable-msc3956")]
152pub mod encrypted;
153#[cfg(feature = "unstable-msc3551")]
154pub mod file;
155pub mod forwarded_room_key;
156pub mod fully_read;
157pub mod identity_server;
158pub mod ignored_user_list;
159#[cfg(feature = "unstable-msc3552")]
160pub mod image;
161#[cfg(feature = "unstable-msc2545")]
162pub mod image_pack;
163pub mod key;
164#[cfg(feature = "unstable-msc3488")]
165pub mod location;
166pub mod marked_unread;
167#[cfg(feature = "unstable-msc4171")]
168pub mod member_hints;
169#[cfg(feature = "unstable-msc1767")]
170pub mod message;
171#[cfg(feature = "unstable-pdu")]
172pub mod pdu;
173pub mod policy;
174#[cfg(feature = "unstable-msc3381")]
175pub mod poll;
176pub mod presence;
177pub mod push_rules;
178pub mod reaction;
179pub mod receipt;
180pub mod relation;
181pub mod room;
182pub mod room_key;
183pub mod room_key_request;
184pub mod secret;
185pub mod secret_storage;
186pub mod space;
187pub mod sticker;
188pub mod tag;
189pub mod typing;
190#[cfg(feature = "unstable-msc3553")]
191pub mod video;
192#[cfg(feature = "unstable-msc3245")]
193pub mod voice;
194
195pub use self::{
196 content::*,
197 enums::*,
198 kinds::*,
199 relation::{BundledMessageLikeRelations, BundledStateRelations},
200 state_key::EmptyStateKey,
201 unsigned::{MessageLikeUnsigned, RedactedUnsigned, StateUnsigned, UnsignedRoomRedactionEvent},
202};
203
204/// Trait to define the behavior of redact an event's content object.
205pub trait RedactContent {
206 /// The redacted form of the event's content.
207 type Redacted;
208
209 /// Transform `self` into a redacted form (removing most or all fields) according to the spec.
210 ///
211 /// A small number of events have room-version specific redaction behavior, so a version has to
212 /// be specified.
213 fn redact(self, version: &RoomVersionId) -> Self::Redacted;
214}
215
216/// Helper struct to determine the event kind from a `serde_json::value::RawValue`.
217#[doc(hidden)]
218#[derive(Deserialize)]
219#[allow(clippy::exhaustive_structs)]
220pub struct EventTypeDeHelper<'a> {
221 #[serde(borrow, rename = "type")]
222 pub ev_type: std::borrow::Cow<'a, str>,
223}
224
225/// Helper struct to determine if an event has been redacted.
226#[doc(hidden)]
227#[derive(Deserialize)]
228#[allow(clippy::exhaustive_structs)]
229pub struct RedactionDeHelper {
230 /// Used to check whether redacted_because exists.
231 pub unsigned: Option<UnsignedDeHelper>,
232}
233
234#[doc(hidden)]
235#[derive(Deserialize)]
236#[allow(clippy::exhaustive_structs)]
237pub struct UnsignedDeHelper {
238 /// This is the field that signals an event has been redacted.
239 pub redacted_because: Option<IgnoredAny>,
240}
241
242/// Helper function for erroring when trying to serialize an event enum _Custom variant that can
243/// only be created by deserializing from an unknown event type.
244#[doc(hidden)]
245#[allow(clippy::ptr_arg)]
246pub fn serialize_custom_event_error<T, S: Serializer>(_: &T, _: S) -> Result<S::Ok, S::Error> {
247 Err(serde::ser::Error::custom(
248 "Failed to serialize event [content] enum: Unknown event type.\n\
249 To send custom events, turn them into `Raw<EnumType>` by going through
250 `serde_json::value::to_raw_value` and `Raw::from_json`.",
251 ))
252}
253
254/// Describes whether the event mentions other users or the room.
255#[derive(Clone, Debug, Default, Serialize, Deserialize)]
256#[non_exhaustive]
257pub struct Mentions {
258 /// The list of mentioned users.
259 ///
260 /// Defaults to an empty `BTreeSet`.
261 #[serde(default, skip_serializing_if = "BTreeSet::is_empty")]
262 pub user_ids: BTreeSet<OwnedUserId>,
263
264 /// Whether the whole room is mentioned.
265 ///
266 /// Defaults to `false`.
267 #[serde(default, skip_serializing_if = "ruma_common::serde::is_default")]
268 pub room: bool,
269}
270
271impl Mentions {
272 /// Create a `Mentions` with the default values.
273 pub fn new() -> Self {
274 Self::default()
275 }
276
277 /// Create a `Mentions` for the given user IDs.
278 pub fn with_user_ids(user_ids: impl IntoIterator<Item = OwnedUserId>) -> Self {
279 Self { user_ids: BTreeSet::from_iter(user_ids), ..Default::default() }
280 }
281
282 /// Create a `Mentions` for a room mention.
283 pub fn with_room_mention() -> Self {
284 Self { room: true, ..Default::default() }
285 }
286
287 fn add(&mut self, mentions: Self) {
288 self.user_ids.extend(mentions.user_ids);
289 self.room |= mentions.room;
290 }
291}
292
293// Wrapper around `Box<str>` that cannot be used in a meaningful way outside of
294// this crate. Used for string enums because their `_Custom` variant can't be
295// truly private (only `#[doc(hidden)]`).
296#[doc(hidden)]
297#[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
298pub struct PrivOwnedStr(Box<str>);
299
300impl fmt::Debug for PrivOwnedStr {
301 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
302 self.0.fmt(f)
303 }
304}