Enum ruma_common::directory::PublicRoomJoinRule

pub enum PublicRoomJoinRule {
    Knock,
    Public,
    // some variants omitted
}

The rule used for users wishing to join a public 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

Knock

Users can request an invite to the room.

Public

Anyone can join the room without any prior action.

Implementations

impl PublicRoomJoinRule

pub fn as_str(&self) -> &str

Creates a string slice from this PublicRoomJoinRule.

Trait Implementations

impl AsRef<str> for PublicRoomJoinRule

fn as_ref(&self) -> &str

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

impl Clone for PublicRoomJoinRule

fn clone(&self) -> PublicRoomJoinRule

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PublicRoomJoinRule

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

Formats the value using the given formatter.

impl Default for PublicRoomJoinRule

fn default() -> PublicRoomJoinRule

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PublicRoomJoinRule

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PublicRoomJoinRule

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

Formats the value using the given formatter.

impl<T> From<T> for PublicRoomJoinRule

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

fn from(s: T) -> Self

Converts to this type from the input type.

impl PartialEq for PublicRoomJoinRule

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

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 PublicRoomJoinRule

impl StructuralPartialEq for PublicRoomJoinRule