ruma_events/policy/rule/
room.rs

Help
1//! Types for the [`m.policy.rule.room`] event.
2//!
3//! [`m.policy.rule.room`]: https://spec.matrix.org/latest/client-server-api/#mpolicyruleroom
4
5use ruma_macros::EventContent;
6use serde::{Deserialize, Serialize};
7
8use super::{PolicyRuleEventContent, PossiblyRedactedPolicyRuleEventContent};
9use crate::{EventContent, PossiblyRedactedStateEventContent, StateEventType};
10
11/// The content of an `m.policy.rule.room` event.
12///
13/// This event type is used to apply rules to room entities.
14#[derive(Clone, Debug, Deserialize, Serialize, EventContent)]
15#[allow(clippy::exhaustive_structs)]
16#[ruma_event(type = "m.policy.rule.room", kind = State, state_key_type = String, custom_possibly_redacted)]
17pub struct PolicyRuleRoomEventContent(pub PolicyRuleEventContent);
18
19/// The possibly redacted form of [`PolicyRuleRoomEventContent`].
20///
21/// This type is used when it's not obvious whether the content is redacted or not.
22#[derive(Clone, Debug, Deserialize, Serialize)]
23#[allow(clippy::exhaustive_structs)]
24pub struct PossiblyRedactedPolicyRuleRoomEventContent(pub PossiblyRedactedPolicyRuleEventContent);
25
26impl EventContent for PossiblyRedactedPolicyRuleRoomEventContent {
27    type EventType = StateEventType;
28
29    fn event_type(&self) -> Self::EventType {
30        StateEventType::PolicyRuleRoom
31    }
32}
33
34impl PossiblyRedactedStateEventContent for PossiblyRedactedPolicyRuleRoomEventContent {
35    type StateKey = String;
36}
37
38#[cfg(test)]
39mod tests {
40    use ruma_common::serde::Raw;
41    use serde_json::{from_value as from_json_value, json, to_value as to_json_value};
42
43    use super::{OriginalPolicyRuleRoomEvent, PolicyRuleRoomEventContent};
44    use crate::policy::rule::{PolicyRuleEventContent, Recommendation};
45
46    #[test]
47    fn serialization() {
48        let content = PolicyRuleRoomEventContent(PolicyRuleEventContent {
49            entity: "#*:example.org".into(),
50            reason: "undesirable content".into(),
51            recommendation: Recommendation::Ban,
52        });
53
54        let json = json!({
55            "entity": "#*:example.org",
56            "reason": "undesirable content",
57            "recommendation": "m.ban"
58        });
59
60        assert_eq!(to_json_value(content).unwrap(), json);
61    }
62
63    #[test]
64    fn deserialization() {
65        let json = json!({
66            "content": {
67                "entity": "#*:example.org",
68                "reason": "undesirable content",
69                "recommendation": "m.ban"
70            },
71            "event_id": "$143273582443PhrSn:example.org",
72            "origin_server_ts": 1_432_735_824_653_u64,
73            "room_id": "!jEsUZKDJdhlrceRyVU:example.org",
74            "sender": "@example:example.org",
75            "state_key": "rule:#*:example.org",
76            "type": "m.policy.rule.room",
77            "unsigned": {
78                "age": 1234
79            }
80        });
81
82        from_json_value::<Raw<OriginalPolicyRuleRoomEvent>>(json).unwrap().deserialize().unwrap();
83    }
84}
ruma_events/policy/rule/room.rs

ruma_events/policy/rule/
room.rs
