chris/ruwuma
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

client-api: Create SpaceRoomJoinRule and use it

Browse Source
This commit is contained in:
Jonas Platte 2022-03-28 14:32:27 +02:00
parent 9de00ae348
commit 0a53fdb391
No known key found for this signature in database
GPG Key ID: BBA95679259D342F
1 changed files with 52 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
crates/ruma-client-api/src/space.rs
View File

@ -6,11 +6,15 @@
use js_int::UInt; use js_int::UInt;
use ruma_common::{ use ruma_common::{
directory::PublicRoomJoinRule, events::space::child::HierarchySpaceChildStateEvent, events::space::child::HierarchySpaceChildStateEvent,
room::RoomType, serde::Raw, MxcUri, RoomAliasId, RoomId, RoomName, room::RoomType,
serde::{Raw, StringEnum},
MxcUri, RoomAliasId, RoomId, RoomName,
}; };
use serde::{Deserialize, Serialize}; use serde::{Deserialize, Serialize};
use crate::PrivOwnedStr;
pub mod get_hierarchy; pub mod get_hierarchy;
/// A chunk of a space hierarchy response, describing one room. /// A chunk of a space hierarchy response, describing one room.
@ -63,7 +67,7 @@ pub struct SpaceHierarchyRoomsChunk {
/// The join rule of the room. /// The join rule of the room.
#[serde(default, skip_serializing_if = "ruma_common::serde::is_default")] #[serde(default, skip_serializing_if = "ruma_common::serde::is_default")]
pub join_rule: PublicRoomJoinRule, pub join_rule: SpaceRoomJoinRule,
/// The type of room from `m.room.create`, if any. /// The type of room from `m.room.create`, if any.
pub room_type: Option<RoomType>, pub room_type: Option<RoomType>,
@ -96,7 +100,7 @@ pub struct SpaceHierarchyRoomsChunkInit {
pub guest_can_join: bool, pub guest_can_join: bool,
/// The join rule of the room. /// The join rule of the room.
pub join_rule: PublicRoomJoinRule, pub join_rule: SpaceRoomJoinRule,
/// The stripped `m.space.child` events of the space-room. /// The stripped `m.space.child` events of the space-room.
/// ///
@ -130,3 +134,47 @@ impl From<SpaceHierarchyRoomsChunkInit> for SpaceHierarchyRoomsChunk {
} }
} }
} }
/// The rule used for users wishing to join a room.
///
/// In contrast to the regular [`JoinRule`](ruma_common::events::room::join_rules::JoinRule), this
/// enum does not hold the conditions for joining restricted rooms. Instead, the server is assumed
/// to only return rooms the user is allowed to join in a space hierarchy listing response.
///
/// This type can hold an arbitrary string. To check for join rules that are not available as a
/// documented variant here, use its string representation, obtained through `.as_str()`.
#[derive(Clone, Debug, PartialEq, Eq, StringEnum)]
#[ruma_enum(rename_all = "snake_case")]
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
pub enum SpaceRoomJoinRule {
/// A user who wishes to join the room must first receive an invite to the room from someone
/// already inside of the room.
Invite,
/// Users can join the room if they are invited, or they can request an invite to the room.
///
/// They can be allowed (invited) or denied (kicked/banned) access.
Knock,
/// Reserved but not yet implemented by the Matrix specification.
Private,
/// Users can join the room if they are invited, or if they meet any of the conditions
/// described in a set of [`AllowRule`](ruma_common::events::room::join_rules::AllowRule)s.
///
/// These rules are not made available as part of a space hierarchy listing response and can
/// only be seen by users inside the room.
Restricted,
/// Anyone can join the room without any prior action.
Public,
#[doc(hidden)]
_Custom(PrivOwnedStr),
}
impl Default for SpaceRoomJoinRule {
fn default() -> Self {
SpaceRoomJoinRule::Public
}
}