ruma_events/
presence.rs

Help
1//! A presence event is represented by a struct with a set content field.
2//!
3//! The only content valid for this event is `PresenceEventContent`.
4
5use js_int::UInt;
6use ruma_common::{presence::PresenceState, OwnedMxcUri, OwnedUserId};
7use ruma_macros::{Event, EventContent};
8use serde::{ser::SerializeStruct, Deserialize, Serialize};
9
10use super::EventContent;
11
12/// Presence event.
13#[derive(Clone, Debug, Event)]
14#[allow(clippy::exhaustive_structs)]
15pub struct PresenceEvent {
16    /// Data specific to the event type.
17    pub content: PresenceEventContent,
18
19    /// Contains the fully-qualified ID of the user who sent this event.
20    pub sender: OwnedUserId,
21}
22
23impl Serialize for PresenceEvent {
24    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
25    where
26        S: serde::Serializer,
27    {
28        let mut state = serializer.serialize_struct("PresenceEvent", 3)?;
29        state.serialize_field("type", &self.content.event_type())?;
30        state.serialize_field("content", &self.content)?;
31        state.serialize_field("sender", &self.sender)?;
32        state.end()
33    }
34}
35
36/// Informs the room of members presence.
37///
38/// This is the only type a `PresenceEvent` can contain as its `content` field.
39#[derive(Clone, Debug, Deserialize, Serialize, EventContent)]
40#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
41#[ruma_event(type = "m.presence")]
42pub struct PresenceEventContent {
43    /// The current avatar URL for this user.
44    ///
45    /// If you activate the `compat-empty-string-null` feature, this field being an empty string in
46    /// JSON will result in `None` here during deserialization.
47    #[serde(skip_serializing_if = "Option::is_none")]
48    #[cfg_attr(
49        feature = "compat-empty-string-null",
50        serde(default, deserialize_with = "ruma_common::serde::empty_string_as_none")
51    )]
52    pub avatar_url: Option<OwnedMxcUri>,
53
54    /// Whether or not the user is currently active.
55    #[serde(skip_serializing_if = "Option::is_none")]
56    pub currently_active: Option<bool>,
57
58    /// The current display name for this user.
59    #[serde(skip_serializing_if = "Option::is_none")]
60    pub displayname: Option<String>,
61
62    /// The last time since this user performed some action, in milliseconds.
63    #[serde(skip_serializing_if = "Option::is_none")]
64    pub last_active_ago: Option<UInt>,
65
66    /// The presence state for this user.
67    pub presence: PresenceState,
68
69    /// An optional description to accompany the presence.
70    #[serde(skip_serializing_if = "Option::is_none")]
71    pub status_msg: Option<String>,
72}
73
74impl PresenceEventContent {
75    /// Creates a new `PresenceEventContent` with the given state.
76    pub fn new(presence: PresenceState) -> Self {
77        Self {
78            avatar_url: None,
79            currently_active: None,
80            displayname: None,
81            last_active_ago: None,
82            presence,
83            status_msg: None,
84        }
85    }
86}
87
88#[cfg(test)]
89mod tests {
90    use js_int::uint;
91    use ruma_common::{mxc_uri, presence::PresenceState};
92    use serde_json::{from_value as from_json_value, json, to_value as to_json_value};
93
94    use super::{PresenceEvent, PresenceEventContent};
95
96    #[test]
97    fn serialization() {
98        let content = PresenceEventContent {
99            avatar_url: Some(mxc_uri!("mxc://localhost/wefuiwegh8742w").to_owned()),
100            currently_active: Some(false),
101            displayname: None,
102            last_active_ago: Some(uint!(2_478_593)),
103            presence: PresenceState::Online,
104            status_msg: Some("Making cupcakes".into()),
105        };
106
107        let json = json!({
108            "avatar_url": "mxc://localhost/wefuiwegh8742w",
109            "currently_active": false,
110            "last_active_ago": 2_478_593,
111            "presence": "online",
112            "status_msg": "Making cupcakes"
113        });
114
115        assert_eq!(to_json_value(&content).unwrap(), json);
116    }
117
118    #[test]
119    fn deserialization() {
120        let json = json!({
121            "content": {
122                "avatar_url": "mxc://localhost/wefuiwegh8742w",
123                "currently_active": false,
124                "last_active_ago": 2_478_593,
125                "presence": "online",
126                "status_msg": "Making cupcakes"
127            },
128            "sender": "@example:localhost",
129            "type": "m.presence"
130        });
131
132        let ev = from_json_value::<PresenceEvent>(json).unwrap();
133        assert_eq!(
134            ev.content.avatar_url.as_deref(),
135            Some(mxc_uri!("mxc://localhost/wefuiwegh8742w"))
136        );
137        assert_eq!(ev.content.currently_active, Some(false));
138        assert_eq!(ev.content.displayname, None);
139        assert_eq!(ev.content.last_active_ago, Some(uint!(2_478_593)));
140        assert_eq!(ev.content.presence, PresenceState::Online);
141        assert_eq!(ev.content.status_msg.as_deref(), Some("Making cupcakes"));
142        assert_eq!(ev.sender, "@example:localhost");
143
144        #[cfg(feature = "compat-empty-string-null")]
145        {
146            let json = json!({
147                "content": {
148                    "avatar_url": "",
149                    "currently_active": false,
150                    "last_active_ago": 2_478_593,
151                    "presence": "online",
152                    "status_msg": "Making cupcakes"
153                },
154                "sender": "@example:localhost",
155                "type": "m.presence"
156            });
157
158            let ev = from_json_value::<PresenceEvent>(json).unwrap();
159            assert_eq!(ev.content.avatar_url, None);
160            assert_eq!(ev.content.currently_active, Some(false));
161            assert_eq!(ev.content.displayname, None);
162            assert_eq!(ev.content.last_active_ago, Some(uint!(2_478_593)));
163            assert_eq!(ev.content.presence, PresenceState::Online);
164            assert_eq!(ev.content.status_msg.as_deref(), Some("Making cupcakes"));
165            assert_eq!(ev.sender, "@example:localhost");
166        }
167    }
168}
ruma_events/presence.rs

ruma_events/
presence.rs
