ruma_events/
unsigned.rs

Help
1use js_int::Int;
2use ruma_common::{
3    serde::CanBeEmpty, MilliSecondsSinceUnixEpoch, OwnedEventId, OwnedTransactionId, OwnedUserId,
4};
5use serde::{de::DeserializeOwned, Deserialize};
6
7use super::{
8    relation::{BundledMessageLikeRelations, BundledStateRelations},
9    room::redaction::RoomRedactionEventContent,
10    MessageLikeEventContent, OriginalSyncMessageLikeEvent, PossiblyRedactedStateEventContent,
11};
12
13/// Extra information about a message event that is not incorporated into the event's hash.
14#[derive(Clone, Debug, Deserialize)]
15#[serde(bound = "OriginalSyncMessageLikeEvent<C>: DeserializeOwned")]
16#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
17pub struct MessageLikeUnsigned<C: MessageLikeEventContent> {
18    /// The time in milliseconds that has elapsed since the event was sent.
19    ///
20    /// This field is generated by the local homeserver, and may be incorrect if the local time on
21    /// at least one of the two servers is out of sync, which can cause the age to either be
22    /// negative or greater than it actually is.
23    pub age: Option<Int>,
24
25    /// The client-supplied transaction ID, if the client being given the event is the same one
26    /// which sent it.
27    pub transaction_id: Option<OwnedTransactionId>,
28
29    /// [Bundled aggregations] of related child events.
30    ///
31    /// [Bundled aggregations]: https://spec.matrix.org/latest/client-server-api/#aggregations-of-child-events
32    #[serde(rename = "m.relations", default)]
33    pub relations: BundledMessageLikeRelations<OriginalSyncMessageLikeEvent<C>>,
34}
35
36impl<C: MessageLikeEventContent> MessageLikeUnsigned<C> {
37    /// Create a new `Unsigned` with fields set to `None`.
38    pub fn new() -> Self {
39        Self { age: None, transaction_id: None, relations: BundledMessageLikeRelations::default() }
40    }
41}
42
43impl<C: MessageLikeEventContent> Default for MessageLikeUnsigned<C> {
44    fn default() -> Self {
45        Self::new()
46    }
47}
48
49impl<C: MessageLikeEventContent> CanBeEmpty for MessageLikeUnsigned<C> {
50    /// Whether this unsigned data is empty (all fields are `None`).
51    ///
52    /// This method is used to determine whether to skip serializing the `unsigned` field in room
53    /// events. Do not use it to determine whether an incoming `unsigned` field was present - it
54    /// could still have been present but contained none of the known fields.
55    fn is_empty(&self) -> bool {
56        self.age.is_none() && self.transaction_id.is_none() && self.relations.is_empty()
57    }
58}
59
60/// Extra information about a state event that is not incorporated into the event's hash.
61#[derive(Clone, Debug, Deserialize)]
62#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
63pub struct StateUnsigned<C: PossiblyRedactedStateEventContent> {
64    /// The time in milliseconds that has elapsed since the event was sent.
65    ///
66    /// This field is generated by the local homeserver, and may be incorrect if the local time on
67    /// at least one of the two servers is out of sync, which can cause the age to either be
68    /// negative or greater than it actually is.
69    pub age: Option<Int>,
70
71    /// The client-supplied transaction ID, if the client being given the event is the same one
72    /// which sent it.
73    pub transaction_id: Option<OwnedTransactionId>,
74
75    /// Optional previous content of the event.
76    pub prev_content: Option<C>,
77
78    /// [Bundled aggregations] of related child events.
79    ///
80    /// [Bundled aggregations]: https://spec.matrix.org/latest/client-server-api/#aggregations-of-child-events
81    #[serde(rename = "m.relations", default)]
82    pub relations: BundledStateRelations,
83}
84
85impl<C: PossiblyRedactedStateEventContent> StateUnsigned<C> {
86    /// Create a new `Unsigned` with fields set to `None`.
87    pub fn new() -> Self {
88        Self { age: None, transaction_id: None, prev_content: None, relations: Default::default() }
89    }
90}
91
92impl<C: PossiblyRedactedStateEventContent> CanBeEmpty for StateUnsigned<C> {
93    /// Whether this unsigned data is empty (all fields are `None`).
94    ///
95    /// This method is used to determine whether to skip serializing the `unsigned` field in room
96    /// events. Do not use it to determine whether an incoming `unsigned` field was present - it
97    /// could still have been present but contained none of the known fields.
98    fn is_empty(&self) -> bool {
99        self.age.is_none()
100            && self.transaction_id.is_none()
101            && self.prev_content.is_none()
102            && self.relations.is_empty()
103    }
104}
105
106impl<C: PossiblyRedactedStateEventContent> Default for StateUnsigned<C> {
107    fn default() -> Self {
108        Self::new()
109    }
110}
111
112/// Extra information about a redacted event that is not incorporated into the event's hash.
113#[derive(Clone, Debug, Deserialize)]
114#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
115pub struct RedactedUnsigned {
116    /// The event that redacted this event, if any.
117    pub redacted_because: UnsignedRoomRedactionEvent,
118}
119
120impl RedactedUnsigned {
121    /// Create a new `RedactedUnsigned` with the given redaction event.
122    pub fn new(redacted_because: UnsignedRoomRedactionEvent) -> Self {
123        Self { redacted_because }
124    }
125}
126
127/// A redaction event as found in `unsigned.redacted_because`.
128///
129/// While servers usually send this with the `redacts` field (unless nested), the ID of the event
130/// being redacted is known from context wherever this type is used, so it's not reflected as a
131/// field here.
132///
133/// It is intentionally not possible to create an instance of this type other than through `Clone`
134/// or `Deserialize`.
135#[derive(Clone, Debug, Deserialize)]
136#[non_exhaustive]
137pub struct UnsignedRoomRedactionEvent {
138    /// Data specific to the event type.
139    pub content: RoomRedactionEventContent,
140
141    /// The globally unique event identifier for the user who sent the event.
142    pub event_id: OwnedEventId,
143
144    /// The fully-qualified ID of the user who sent this event.
145    pub sender: OwnedUserId,
146
147    /// Timestamp in milliseconds on originating homeserver when this event was sent.
148    pub origin_server_ts: MilliSecondsSinceUnixEpoch,
149
150    /// Additional key-value pairs not signed by the homeserver.
151    #[serde(default)]
152    pub unsigned: MessageLikeUnsigned<RoomRedactionEventContent>,
153}
ruma_events/unsigned.rs

ruma_events/
unsigned.rs
