ruma_events/room/
encryption.rs

Help
1//! Types for the [`m.room.encryption`] event.
2//!
3//! [`m.room.encryption`]: https://spec.matrix.org/latest/client-server-api/#mroomencryption
4
5use js_int::{uint, UInt};
6use ruma_macros::EventContent;
7use serde::{Deserialize, Serialize};
8
9use crate::{EmptyStateKey, EventEncryptionAlgorithm};
10
11/// The content of an `m.room.encryption` event.
12///
13/// Defines how messages sent in this room should be encrypted.
14#[derive(Clone, Debug, Deserialize, Serialize, EventContent)]
15#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
16#[ruma_event(type = "m.room.encryption", kind = State, state_key_type = EmptyStateKey)]
17pub struct RoomEncryptionEventContent {
18    /// The encryption algorithm to be used to encrypt messages sent in this room.
19    ///
20    /// Must be `m.megolm.v1.aes-sha2`.
21    pub algorithm: EventEncryptionAlgorithm,
22
23    /// How long the session should be used before changing it.
24    ///
25    /// `uint!(604800000)` (a week) is the recommended default.
26    #[serde(skip_serializing_if = "Option::is_none")]
27    pub rotation_period_ms: Option<UInt>,
28
29    /// How many messages should be sent before changing the session.
30    ///
31    /// `uint!(100)` is the recommended default.
32    #[serde(skip_serializing_if = "Option::is_none")]
33    pub rotation_period_msgs: Option<UInt>,
34}
35
36impl RoomEncryptionEventContent {
37    /// Creates a new `RoomEncryptionEventContent` with the given algorithm.
38    pub fn new(algorithm: EventEncryptionAlgorithm) -> Self {
39        Self { algorithm, rotation_period_ms: None, rotation_period_msgs: None }
40    }
41
42    /// Creates a new `RoomEncryptionEventContent` with the mandatory algorithm and the recommended
43    /// defaults.
44    ///
45    /// Note that changing the values of the fields is not a breaking change and you shouldn't rely
46    /// on those specific values.
47    pub fn with_recommended_defaults() -> Self {
48        // Defaults defined at <https://spec.matrix.org/latest/client-server-api/#mroomencryption>
49        Self {
50            algorithm: EventEncryptionAlgorithm::MegolmV1AesSha2,
51            rotation_period_ms: Some(uint!(604_800_000)),
52            rotation_period_msgs: Some(uint!(100)),
53        }
54    }
55}
ruma_events/room/encryption.rs

ruma_events/room/
encryption.rs
