Enum JoinRuleKind 

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

The kind of rule used for users wishing to join this room.

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 rules.

KnockRestricted

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

Public

Anyone can join the room without any prior action.

Implementations

impl JoinRuleKind

pub fn as_str(&self) -> &str

Available on crate feature events only.

Creates a string slice from this JoinRuleKind.

Trait Implementations

impl AsRef<str> for JoinRuleKind

fn as_ref(&self) -> &str

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

impl Clone for JoinRuleKind

fn clone(&self) -> JoinRuleKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for JoinRuleKind

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

Formats the value using the given formatter.

impl Default for JoinRuleKind

fn default() -> JoinRuleKind

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for JoinRuleKind

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for JoinRuleKind

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

Formats the value using the given formatter.

impl From<JoinRuleKind> for JoinRuleSummary

fn from(value: JoinRuleKind) -> JoinRuleSummary

Converts to this type from the input type.

impl<T> From<T> for JoinRuleKind

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

fn from(s: T) -> JoinRuleKind

Converts to this type from the input type.

impl Ord for JoinRuleKind

fn cmp(&self, other: &JoinRuleKind) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for JoinRuleKind

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

fn partial_cmp(&self, other: &JoinRuleKind) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for JoinRuleKind

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 JoinRuleKind