ruma_state_res/events/
join_rules.rs

Help
1//! Types to deserialize `m.room.join_rules` events.
2
3use std::ops::Deref;
4
5use ruma_common::serde::{from_raw_json_value, PartialEqAsRefStr, StringEnum};
6use serde::Deserialize;
7
8use super::Event;
9
10/// A helper type for an [`Event`] of type `m.room.join_rules`.
11///
12/// This is a type that deserializes each field lazily, when requested.
13#[derive(Debug, Clone)]
14pub struct RoomJoinRulesEvent<E: Event>(E);
15
16impl<E: Event> RoomJoinRulesEvent<E> {
17    /// Construct a new `RoomJoinRulesEvent` around the given event.
18    pub fn new(event: E) -> Self {
19        Self(event)
20    }
21
22    /// The join rule of the room.
23    pub fn join_rule(&self) -> Result<JoinRule, String> {
24        #[derive(Deserialize)]
25        struct RoomJoinRulesContentJoinRule {
26            join_rule: JoinRule,
27        }
28
29        let content: RoomJoinRulesContentJoinRule =
30            from_raw_json_value(self.content()).map_err(|err: serde_json::Error| {
31                format!("missing or invalid `join_rule` field in `m.room.join_rules` event: {err}")
32            })?;
33        Ok(content.join_rule)
34    }
35}
36
37impl<E: Event> Deref for RoomJoinRulesEvent<E> {
38    type Target = E;
39
40    fn deref(&self) -> &Self::Target {
41        &self.0
42    }
43}
44
45#[derive(Clone, StringEnum, PartialEqAsRefStr)]
46#[ruma_enum(rename_all = "snake_case")]
47#[non_exhaustive]
48pub enum JoinRule {
49    /// `public`
50    Public,
51
52    /// `invite`
53    Invite,
54
55    /// `knock`
56    Knock,
57
58    /// `restricted`
59    Restricted,
60
61    /// `KnockRestricted`
62    KnockRestricted,
63
64    #[doc(hidden)]
65    _Custom(PrivOwnedStr),
66}
67
68impl Eq for JoinRule {}
69
70// Wrapper around `Box<str>` that cannot be used in a meaningful way outside of
71// this crate. Used for string enums because their `_Custom` variant can't be
72// truly private (only `#[doc(hidden)]`).
73#[derive(Debug, Clone)]
74pub struct PrivOwnedStr(Box<str>);
ruma_state_res/events/join_rules.rs

ruma_state_res/events/
join_rules.rs
