Enum ruma_common::events::room::join_rules::JoinRule

#[non_exhaustive]
pub enum JoinRule {
    Invite,
    Knock,
    Private,
    Restricted(Restricted),
    Public,
    // some variants omitted
}

The rule used for users wishing to join this room.

This type can hold an arbitrary string. To check for formats 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(Restricted)

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

Public

Anyone can join the room without any prior action.

Implementations

impl JoinRule

pub fn as_str(&self) -> &str

Returns the string name of this JoinRule

Trait Implementations

impl Clone for JoinRule

fn clone(&self) -> JoinRule

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for JoinRule

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for JoinRule

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

Deserialize this value from the given Serde deserializer.

impl PartialEq<JoinRule> for JoinRule

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Serialize for JoinRule

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl Eq for JoinRule

impl StructuralEq for JoinRule

impl StructuralPartialEq for JoinRule