Enum SpaceRoomJoinRule

#[non_exhaustive]
pub enum SpaceRoomJoinRule {
    Invite,
    Knock,
    Private,
    Restricted,
    KnockRestricted,
    Public,
}

The rule used for users wishing to join a room.

In contrast to the regular JoinRule in ruma_events, 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 build this with a custom value, convert it from a string with ::from() / .into(). To check for values that are not available as a documented variant here, use its string representation, obtained through .as_str().

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Invite

A user who wishes to join the room must first receive an invite to the room from someone already inside of the room.

Knock

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.

Private

Reserved but not yet implemented by the Matrix specification.

Restricted

Users can join the room if they are invited, or if they meet any of the conditions described in a set of allow rules.

These rules are not made available as part of a space hierarchy listing response and can only be seen by users inside the room.

KnockRestricted

Users can join the room if they are invited, or if they meet any of the conditions described in a set of allow rules, or they can request an invite to the room.

Public

Anyone can join the room without any prior action.

Implementations

impl SpaceRoomJoinRule

pub fn as_str(&self) -> &str

Available on crate feature events only.

Creates a string slice from this SpaceRoomJoinRule.

Trait Implementations

impl AsRef<str> for SpaceRoomJoinRule

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for SpaceRoomJoinRule

fn clone(&self) -> SpaceRoomJoinRule

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SpaceRoomJoinRule

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for SpaceRoomJoinRule

fn default() -> SpaceRoomJoinRule

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SpaceRoomJoinRule

fn deserialize<D>( deserializer: D, ) -> Result<SpaceRoomJoinRule, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SpaceRoomJoinRule

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl From<JoinRule> for SpaceRoomJoinRule

fn from(value: JoinRule) -> SpaceRoomJoinRule

Converts to this type from the input type.

impl<T> From<T> for SpaceRoomJoinRule

where T: AsRef<str> + Into<Box<str>>,

fn from(s: T) -> SpaceRoomJoinRule

Converts to this type from the input type.

impl PartialEq for SpaceRoomJoinRule

fn eq(&self, other: &SpaceRoomJoinRule) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for SpaceRoomJoinRule

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for SpaceRoomJoinRule

impl StructuralPartialEq for SpaceRoomJoinRule