Enum JoinRuleSummary

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

The rule used for users wishing to join a room.

In contrast to the regular JoinRule in ruma_events, this enum holds only simplified conditions for joining restricted rooms.

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(RestrictedSummary)

Users can join the room if they are invited, or if they meet one of the conditions described in the RestrictedSummary.

KnockRestricted(RestrictedSummary)

Users can join the room if they are invited, or if they meet one of the conditions described in the RestrictedSummary, or they can request an invite to the room.

Public

Anyone can join the room without any prior action.

Implementations

impl JoinRuleSummary

pub fn kind(&self) -> JoinRuleKind

Returns the kind of this JoinRuleSummary.

pub fn as_str(&self) -> &str

Returns the string name of this JoinRuleSummary.

Trait Implementations

impl Clone for JoinRuleSummary

fn clone(&self) -> JoinRuleSummary

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for JoinRuleSummary

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

Formats the value using the given formatter.

impl Default for JoinRuleSummary

fn default() -> JoinRuleSummary

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for JoinRuleSummary

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<JoinRule> for JoinRuleSummary

fn from(value: JoinRule) -> Self

Converts to this type from the input type.

impl From<JoinRuleKind> for JoinRuleSummary

fn from(value: JoinRuleKind) -> Self

Converts to this type from the input type.

impl PartialEq for JoinRuleSummary

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

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 JoinRuleSummary

impl StructuralPartialEq for JoinRuleSummary