ruma-events 0.35.0

Serializable types for the events in the Matrix specification.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102

//! Types for the `m.room.presence_sharing` state event.
//!
//! This event uses the unstable prefix defined in [MSC4495].
//!
//! [MSC4495]: https://github.com/matrix-org/matrix-spec-proposals/pull/4495

use ruma_macros::{EventContent, StringEnum};
use serde::{Deserialize, Serialize};

use crate::{EmptyStateKey, PrivOwnedStr};

/// A room's presence sharing hint.
///
/// The room's presence sharing hint indicates either:
/// 1. Sharing presence within the room is prohibited ([Self::Forbid]), or
/// 2. Sharing presence within the room should be recommended by clients ([Self::Suggest])
///
/// This type is defined in [MSC4495].
///
/// [MSC4495]: https://github.com/matrix-org/matrix-spec-proposals/pull/4495
#[derive(Clone, StringEnum)]
#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
#[ruma_enum(rename_all = "snake_case")]
pub enum PresenceSharingHint {
    /// Sharing presence within the room is prohibited.
    Forbid,

    /// Sharing presence within the room should be recommended by clients.
    Suggest,

    #[doc(hidden)]
    _Custom(PrivOwnedStr),
}

/// The content of an `m.room.presence_sharing` event.
///
/// The room's presence sharing hint indicates either:
/// 1. Sharing presence within the room is prohibited (`forbid`), or
/// 2. Sharing presence within the room should be recommended by clients (`suggest`)
///
/// This event uses the unstable prefix defined in [MSC4495].
///
/// [MSC4495]: https://github.com/matrix-org/matrix-spec-proposals/pull/4495
#[derive(Clone, Debug, Serialize, Deserialize, EventContent)]
#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
#[ruma_event(type = "org.continuwuity.presence_v2.msc4495.room.presence_sharing", kind = State, state_key_type = EmptyStateKey)]
pub struct RoomPresenceSharingEventContent {
    /// The room's presence sharing hint.
    pub presence_sharing: PresenceSharingHint,
}

impl RoomPresenceSharingEventContent {
    /// Creates a new `RoomPresenceSharingEventContent` with the given hint.
    pub fn new(hint: PresenceSharingHint) -> Self {
        Self { presence_sharing: hint }
    }
}

#[cfg(test)]
mod tests {
    use ruma_common::canonical_json::assert_to_canonical_json_eq;
    use serde_json::{from_value as from_json_value, json};

    use super::{PresenceSharingHint, RoomPresenceSharingEventContent};
    use crate::OriginalStateEvent;

    #[test]
    fn serialization() {
        let content =
            RoomPresenceSharingEventContent { presence_sharing: PresenceSharingHint::Forbid };

        assert_to_canonical_json_eq!(
            content,
            json!({
                "presence_sharing": "forbid",
            }),
        );
    }

    #[test]
    fn deserialization() {
        let json_data = json!({
            "content": {
                "presence_sharing": "suggest"
            },
            "event_id": "$h29iv0s8:example.com",
            "origin_server_ts": 1,
            "room_id": "!n8f893n9:example.com",
            "sender": "@carl:example.com",
            "state_key": "",
            "type": "org.continuwuity.presence_v2.msc4495.room.presence_sharing"
        });

        assert_eq!(
            from_json_value::<OriginalStateEvent<RoomPresenceSharingEventContent>>(json_data)
                .unwrap()
                .content
                .presence_sharing,
            PresenceSharingHint::Suggest
        );
    }
}