Enum JoinRule 

#[non_exhaustive]
pub enum JoinRule {
    Invite,
    Knock,
    Private,
    Restricted(Restricted),
    KnockRestricted(Restricted),
    Public,
}

Available on crate feature events only.

The rule used for users wishing to join this room.

This type can hold an arbitrary join rule. To check for values that are not available as a documented variant here, get its kind with .kind() or its string representation with .as_str(), and its associated data with .data().

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.

KnockRestricted(Restricted)

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

Public

Anyone can join the room without any prior action.

Implementations

impl JoinRule

pub fn kind(&self) -> JoinRuleKind

Returns the kind of this JoinRule.

pub fn as_str(&self) -> &str

Returns the string name of this JoinRule

pub fn data(&self) -> Cow<'_, Map<String, Value>>

Returns the associated data of this JoinRule.

The returned JSON object won’t contain the join_rule field, use .kind() or .as_str() to access those.

Prefer to use the public variants of JoinRule where possible; this method is meant to be used for custom join rules only.

Trait Implementations

impl Clone for JoinRule

fn clone(&self) -> JoinRule

Returns a duplicate 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<(), Error>

Formats the value using the given formatter.

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

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<JoinRule> for JoinRuleSummary

fn from(value: JoinRule) -> JoinRuleSummary

Converts to this type from the input type.

impl PartialEq for JoinRule

fn eq(&self, other: &JoinRule) -> 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 JoinRule

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 JoinRule

impl StructuralPartialEq for JoinRule