Module ruma_common::events
source · [−]Expand description
(De)serializable types for the events in the Matrix specification. These types are used by other Ruma crates.
All data exchanged over Matrix is expressed as an event. Different event types represent different actions, such as joining a room or sending a message. Events are stored and transmitted as simple JSON structures. While anyone can create a new event type for their own purposes, the Matrix specification defines a number of event types which are considered core to the protocol. This module contains Rust types for all of the event types defined by the specification and facilities for extending the event system for custom event types.
Core event types
This module includes Rust types for all event types in the Matrix specification.
To better organize the crate, these types live in separate modules with a hierarchy that matches
the reverse domain name notation of the event type. For example, the m.room.message event
lives at ruma::events::room::message::RoomMessageEvent. Each type’s module also contains a
Rust type for that event type’s content field, and any other supporting types required by the
event’s other fields.
Extending Ruma with custom events
For our examples we will start with a simple custom state event. ruma_event
specifies the state event’s type and it’s kind.
use ruma_common::events::macros::EventContent;
use serde::{Deserialize, Serialize};
#[derive(Clone, Debug, Deserialize, Serialize, EventContent)]
#[ruma_event(type = "org.example.event", kind = State, state_key_type = String)]
pub struct ExampleContent {
field: String,
}This can be used with events structs, such as passing it into
ruma::api::client::state::send_state_event’s Request.
As a more advanced example we create a reaction message event. For this event we will use a
OriginalSyncMessageLikeEvent struct but any OriginalMessageLikeEvent struct would work.
use ruma_common::{
events::{macros::EventContent, OriginalSyncMessageLikeEvent},
OwnedEventId,
};
use serde::{Deserialize, Serialize};
#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(tag = "rel_type")]
pub enum RelatesTo {
#[serde(rename = "m.annotation")]
Annotation {
/// The event this reaction relates to.
event_id: OwnedEventId,
/// The displayable content of the reaction.
key: String,
},
/// Since this event is not fully specified in the Matrix spec
/// it may change or types may be added, we are ready!
#[serde(rename = "m.whatever")]
Whatever,
}
/// The payload for our reaction event.
#[derive(Clone, Debug, Deserialize, Serialize, EventContent)]
#[ruma_event(type = "m.reaction", kind = MessageLike)]
pub struct ReactionEventContent {
#[serde(rename = "m.relates_to")]
pub relates_to: RelatesTo,
}
let json = serde_json::json!({
"content": {
"m.relates_to": {
"event_id": "$xxxx-xxxx",
"key": "👍",
"rel_type": "m.annotation"
}
},
"event_id": "$xxxx-xxxx",
"origin_server_ts": 1,
"sender": "@someone:example.org",
"type": "m.reaction",
"unsigned": {
"age": 85
}
});
// The downside of this event is we cannot use it with event enums,
// but could be deserialized from a `Raw<_>` that has failed to deserialize.
matches::assert_matches!(
serde_json::from_value::<OriginalSyncMessageLikeEvent<ReactionEventContent>>(json),
Ok(OriginalSyncMessageLikeEvent {
content: ReactionEventContent {
relates_to: RelatesTo::Annotation { key, .. },
},
..
}) if key == "👍"
);Modules
Modules for events in the m.call namespace.
Types for the m.forwarded_room_key event.
Types for the m.fully_read event.
Types for the m.identity_server event.
Types for the m.ignored_user_list event.
Modules for events in the m.key namespace.
Re-export of all the derives needed to create your own event types.
Modules for events in the m.policy namespace.
A presence event is represented by a struct with a set content field.
Types for the m.push_rules event.
Types for the m.reaction event.
Modules for events in the m.room namespace.
Types for the m.room_key event.
Types for the m.room_key_request event.
Module for events in the m.secret namespace.
Module for events in the m.secret_storage namespace.
Types for the m.space events.
Structs
The decrypted payload of an m.megolm.v1.aes-sha2 event.
The decrypted payload of an m.olm.v1.curve25519-aes-sha2 event.
A type that can be used as the state_key for event types where that field is always empty.
An ephemeral room event.
A global account data event.
A minimal state event, used for creating a new room.
Extra information about a message event that is not incorporated into the event’s hash.
Public keys used for an m.olm.v1.curve25519-aes-sha2 event.
An unredacted message-like event.
An unredacted state event.
An unredacted message-like event without a room_id.
An unredacted state event without a room_id.
A redacted message-like event.
A redacted state event.
A redacted message-like event without a room_id.
A redacted state event without a room_id.
Extra information about a redacted event that is not incorporated into the event’s hash.
A room account data event.
Extra information about a state event that is not incorporated into the event’s hash.
A stripped-down state event, used for previews of rooms the user has been invited to.
An ephemeral room event without a room_id.
An event sent using send-to-device messaging.
Enums
Any ephemeral room event.
Any ephemeral room event.
Any global account data event.
Any global account data event.
Any state event.
Any message-like event.
Any message-like event.
Any room account data event.
Any room account data event.
Any room event.
Any state event.
Any state event.
Any state event.
Any ephemeral room event.
Any message-like event.
Any sync room event.
Any state event.
Any to-device event.
Any to-device event.
The type of EphemeralRoomEvent this is.
The “kind” of an event.
The type of Event this is.
The type of GlobalAccountDataEvent this is.
A possibly-redacted message-like event.
The type of MessageLikeEvent this is.
The type of RoomAccountDataEvent this is.
The type of RoomEvent this is.
A possibly-redacted state event.
The type of StateEvent this is.
A possibly-redacted message-like event without a room_id.
A possibly-redacted state event without a room_id.
The type of ToDeviceEvent this is.
Traits
An alias for EventContent<EventType = EphemeralRoomEventType>.
The base trait that all event content types implement.
An alias for EventContent<EventType = GlobalAccountDataEventType>.
An alias for EventContent<EventType = MessageLikeEventType>.
Trait to define the behavior of redacting an event.
Trait to define the behavior of redact an event’s content object.
The base trait that all redacted event content types implement.
An alias for MessageLikeEventContent + RedactedEventContent.
An alias for StateEventContent + RedactedEventContent.
An alias for EventContent<EventType = RoomAccountDataEventType>.
An alias for EventContent<EventType = StateEventType>.
Trait for abstracting over event content structs.
An alias for EventContent<EventType = ToDeviceEventType>.