ruma_events/
dummy.rs

Help
1//! Types for the [`m.dummy`] event.
2//!
3//! [`m.dummy`]: https://spec.matrix.org/latest/client-server-api/#mdummy
4
5use std::fmt;
6
7use ruma_macros::EventContent;
8use serde::{
9    de::{self, Deserialize, Deserializer},
10    ser::{Serialize, SerializeStruct as _, Serializer},
11};
12
13/// The content of an `m.dummy` event.
14///
15/// This event is used to indicate new Olm sessions for end-to-end encryption.
16///
17/// Typically it is encrypted as an `m.room.encrypted` event, then sent as a to-device event.
18///
19/// The event does not have any content associated with it. The sending client is expected to
20/// send a key share request shortly after this message, causing the receiving client to process
21/// this `m.dummy` event as the most recent event and using the keyshare request to set up the
22/// session. The keyshare request and `m.dummy` combination should result in the original sending
23/// client receiving keys over the newly established session.
24#[derive(Clone, Debug, Default, EventContent)]
25#[allow(clippy::exhaustive_structs)]
26#[ruma_event(type = "m.dummy", kind = ToDevice)]
27pub struct ToDeviceDummyEventContent;
28
29impl ToDeviceDummyEventContent {
30    /// Create a new `ToDeviceDummyEventContent`.
31    pub fn new() -> Self {
32        Self
33    }
34}
35
36impl<'de> Deserialize<'de> for ToDeviceDummyEventContent {
37    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
38    where
39        D: Deserializer<'de>,
40    {
41        struct Visitor;
42
43        impl<'de> de::Visitor<'de> for Visitor {
44            type Value = ToDeviceDummyEventContent;
45
46            fn expecting(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
47                formatter.write_str("a struct")
48            }
49
50            fn visit_map<A>(self, mut map: A) -> Result<Self::Value, A::Error>
51            where
52                A: de::MapAccess<'de>,
53            {
54                while map.next_entry::<de::IgnoredAny, de::IgnoredAny>()?.is_some() {}
55                Ok(ToDeviceDummyEventContent)
56            }
57        }
58
59        deserializer.deserialize_struct("ToDeviceDummyEventContent", &[], Visitor)
60    }
61}
62
63impl Serialize for ToDeviceDummyEventContent {
64    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
65    where
66        S: Serializer,
67    {
68        serializer.serialize_struct("ToDeviceDummyEventContent", 0)?.end()
69    }
70}
ruma_events/dummy.rs

ruma_events/
dummy.rs
