ruma_events/room/
guest_access.rs

Help
1//! Types for the [`m.room.guest_access`] event.
2//!
3//! [`m.room.guest_access`]: https://spec.matrix.org/latest/client-server-api/#mroomguest_access
4
5use ruma_common::serde::StringEnum;
6use ruma_macros::EventContent;
7use serde::{Deserialize, Serialize};
8
9use crate::{EmptyStateKey, PrivOwnedStr};
10
11/// The content of an `m.room.guest_access` event.
12///
13/// Controls whether guest users are allowed to join rooms.
14///
15/// This event controls whether guest users are allowed to join rooms. If this event is absent,
16/// servers should act as if it is present and has the value `GuestAccess::Forbidden`.
17#[derive(Clone, Debug, Deserialize, Serialize, EventContent)]
18#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
19#[ruma_event(type = "m.room.guest_access", kind = State, state_key_type = EmptyStateKey)]
20pub struct RoomGuestAccessEventContent {
21    /// A policy for guest user access to a room.
22    pub guest_access: GuestAccess,
23}
24
25impl RoomGuestAccessEventContent {
26    /// Creates a new `RoomGuestAccessEventContent` with the given policy.
27    pub fn new(guest_access: GuestAccess) -> Self {
28        Self { guest_access }
29    }
30}
31
32impl RoomGuestAccessEvent {
33    /// Obtain the guest access policy, regardless of whether this event is redacted.
34    pub fn guest_access(&self) -> &GuestAccess {
35        match self {
36            Self::Original(ev) => &ev.content.guest_access,
37            Self::Redacted(_) => &GuestAccess::Forbidden,
38        }
39    }
40}
41
42impl SyncRoomGuestAccessEvent {
43    /// Obtain the guest access policy, regardless of whether this event is redacted.
44    pub fn guest_access(&self) -> &GuestAccess {
45        match self {
46            Self::Original(ev) => &ev.content.guest_access,
47            Self::Redacted(_) => &GuestAccess::Forbidden,
48        }
49    }
50}
51
52/// A policy for guest user access to a room.
53#[doc = include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/src/doc/string_enum.md"))]
54#[derive(Clone, PartialEq, Eq, StringEnum)]
55#[ruma_enum(rename_all = "snake_case")]
56#[non_exhaustive]
57pub enum GuestAccess {
58    /// Guests are allowed to join the room.
59    CanJoin,
60
61    /// Guests are not allowed to join the room.
62    Forbidden,
63
64    #[doc(hidden)]
65    _Custom(PrivOwnedStr),
66}
ruma_events/room/guest_access.rs

ruma_events/room/
guest_access.rs
