ruma_common/space.rs
1//! Common types for [spaces].
2//!
3//! [spaces]: https://spec.matrix.org/latest/client-server-api/#spaces
4
5use ruma_macros::StringEnum;
6
7use crate::PrivOwnedStr;
8
9/// The rule used for users wishing to join a room.
10///
11/// In contrast to the regular `JoinRule` in `ruma_events`, this enum does not hold the conditions
12/// for joining restricted rooms. Instead, the server is assumed to only return rooms the user is
13/// allowed to join in a space hierarchy listing response.
14#[doc = include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/src/doc/string_enum.md"))]
15#[derive(Clone, Default, PartialEq, Eq, StringEnum)]
16#[ruma_enum(rename_all = "snake_case")]
17#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
18pub enum SpaceRoomJoinRule {
19 /// A user who wishes to join the room must first receive an invite to the room from someone
20 /// already inside of the room.
21 Invite,
22
23 /// Users can join the room if they are invited, or they can request an invite to the room.
24 ///
25 /// They can be allowed (invited) or denied (kicked/banned) access.
26 Knock,
27
28 /// Reserved but not yet implemented by the Matrix specification.
29 Private,
30
31 /// Users can join the room if they are invited, or if they meet any of the conditions
32 /// described in a set of allow rules.
33 ///
34 /// These rules are not made available as part of a space hierarchy listing response and can
35 /// only be seen by users inside the room.
36 Restricted,
37
38 /// Users can join the room if they are invited, or if they meet any of the conditions
39 /// described in a set of allow rules, or they can request an invite to the room.
40 KnockRestricted,
41
42 /// Anyone can join the room without any prior action.
43 #[default]
44 Public,
45
46 #[doc(hidden)]
47 _Custom(PrivOwnedStr),
48}