ruma_events/
pdu.rs

Help
1//! Types for persistent data unit schemas
2//!
3//! The differences between the `RoomV1Pdu` schema and the `RoomV3Pdu` schema are that the
4//! `RoomV1Pdu` takes an `event_id` field (`RoomV3Pdu` does not), and `auth_events` and
5//! `prev_events` take `Vec<(OwnedEventId, EventHash)>` rather than `Vec<OwnedEventId>` in
6//! `RoomV3Pdu`.
7
8use std::collections::BTreeMap;
9
10use js_int::UInt;
11use ruma_common::{
12    MilliSecondsSinceUnixEpoch, OwnedEventId, OwnedRoomId, OwnedUserId, ServerSignatures,
13};
14use serde::{
15    de::{Error as _, IgnoredAny},
16    Deserialize, Deserializer, Serialize,
17};
18use serde_json::{from_str as from_json_str, value::RawValue as RawJsonValue};
19
20use super::TimelineEventType;
21
22/// Enum for PDU schemas
23#[derive(Clone, Debug, Serialize)]
24#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
25#[serde(untagged)]
26pub enum Pdu {
27    /// PDU for room versions 1 and 2.
28    RoomV1Pdu(RoomV1Pdu),
29
30    /// PDU for room versions 3 and above.
31    RoomV3Pdu(RoomV3Pdu),
32}
33
34/// A 'persistent data unit' (event) for room versions 1 and 2.
35#[derive(Clone, Debug, Deserialize, Serialize)]
36#[allow(clippy::exhaustive_structs)]
37pub struct RoomV1Pdu {
38    /// Event ID for the PDU.
39    pub event_id: OwnedEventId,
40
41    /// The room this event belongs to.
42    pub room_id: OwnedRoomId,
43
44    /// The user id of the user who sent this event.
45    pub sender: OwnedUserId,
46
47    /// Timestamp (milliseconds since the UNIX epoch) on originating homeserver
48    /// of when this event was created.
49    pub origin_server_ts: MilliSecondsSinceUnixEpoch,
50
51    // TODO: Encode event type as content enum variant, like event enums do
52    /// The event's type.
53    #[serde(rename = "type")]
54    pub kind: TimelineEventType,
55
56    /// The event's content.
57    pub content: Box<RawJsonValue>,
58
59    /// A key that determines which piece of room state the event represents.
60    #[serde(skip_serializing_if = "Option::is_none")]
61    pub state_key: Option<String>,
62
63    /// Event IDs for the most recent events in the room that the homeserver was
64    /// aware of when it created this event.
65    #[serde(skip_serializing_if = "Vec::is_empty")]
66    pub prev_events: Vec<(OwnedEventId, EventHash)>,
67
68    /// The maximum depth of the `prev_events`, plus one.
69    pub depth: UInt,
70
71    /// Event IDs for the authorization events that would allow this event to be
72    /// in the room.
73    #[serde(skip_serializing_if = "Vec::is_empty")]
74    pub auth_events: Vec<(OwnedEventId, EventHash)>,
75
76    /// For redaction events, the ID of the event being redacted.
77    #[serde(skip_serializing_if = "Option::is_none")]
78    pub redacts: Option<OwnedEventId>,
79
80    /// Additional data added by the origin server but not covered by the
81    /// signatures.
82    #[serde(default, skip_serializing_if = "BTreeMap::is_empty")]
83    pub unsigned: BTreeMap<String, Box<RawJsonValue>>,
84
85    /// Content hashes of the PDU.
86    pub hashes: EventHash,
87
88    /// Signatures for the PDU.
89    pub signatures: ServerSignatures,
90}
91
92/// A 'persistent data unit' (event) for room versions 3 and beyond.
93#[derive(Clone, Debug, Deserialize, Serialize)]
94#[allow(clippy::exhaustive_structs)]
95pub struct RoomV3Pdu {
96    /// The room this event belongs to.
97    pub room_id: OwnedRoomId,
98
99    /// The user id of the user who sent this event.
100    pub sender: OwnedUserId,
101
102    /// Timestamp (milliseconds since the UNIX epoch) on originating homeserver
103    /// of when this event was created.
104    pub origin_server_ts: MilliSecondsSinceUnixEpoch,
105
106    // TODO: Encode event type as content enum variant, like event enums do
107    /// The event's type.
108    #[serde(rename = "type")]
109    pub kind: TimelineEventType,
110
111    /// The event's content.
112    pub content: Box<RawJsonValue>,
113
114    /// A key that determines which piece of room state the event represents.
115    #[serde(skip_serializing_if = "Option::is_none")]
116    pub state_key: Option<String>,
117
118    /// Event IDs for the most recent events in the room that the homeserver was
119    /// aware of when it created this event.
120    pub prev_events: Vec<OwnedEventId>,
121
122    /// The maximum depth of the `prev_events`, plus one.
123    pub depth: UInt,
124
125    /// Event IDs for the authorization events that would allow this event to be
126    /// in the room.
127    pub auth_events: Vec<OwnedEventId>,
128
129    /// For redaction events, the ID of the event being redacted.
130    #[serde(skip_serializing_if = "Option::is_none")]
131    pub redacts: Option<OwnedEventId>,
132
133    /// Additional data added by the origin server but not covered by the
134    /// signatures.
135    #[serde(default, skip_serializing_if = "BTreeMap::is_empty")]
136    pub unsigned: BTreeMap<String, Box<RawJsonValue>>,
137
138    /// Content hashes of the PDU.
139    pub hashes: EventHash,
140
141    /// Signatures for the PDU.
142    pub signatures: ServerSignatures,
143}
144
145/// Content hashes of a PDU.
146#[derive(Clone, Debug, Deserialize, Serialize)]
147#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
148pub struct EventHash {
149    /// The SHA-256 hash.
150    pub sha256: String,
151}
152
153impl EventHash {
154    /// Create a new `EventHash` with the given SHA256 hash.
155    pub fn new(sha256: String) -> Self {
156        Self { sha256 }
157    }
158}
159
160impl<'de> Deserialize<'de> for Pdu {
161    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
162    where
163        D: Deserializer<'de>,
164    {
165        #[derive(Deserialize)]
166        struct GetEventId {
167            event_id: Option<IgnoredAny>,
168        }
169
170        let json = Box::<RawJsonValue>::deserialize(deserializer)?;
171        if from_json_str::<GetEventId>(json.get()).map_err(D::Error::custom)?.event_id.is_some() {
172            from_json_str(json.get()).map(Self::RoomV1Pdu).map_err(D::Error::custom)
173        } else {
174            from_json_str(json.get()).map(Self::RoomV3Pdu).map_err(D::Error::custom)
175        }
176    }
177}
ruma_events/pdu.rs

ruma_events/
pdu.rs
