Enum ruma::events::room::member::MembershipState

#[non_exhaustive]
pub enum MembershipState {
    Ban,
    Invite,
    Join,
    Knock,
    Leave,
}

Available on crate feature events only.

The membership state of a user.

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.

Ban

The user is banned.

Invite

The user has been invited.

Join

The user has joined.

Knock

The user has requested to join.

Leave

The user has left.

Implementations

impl MembershipState

pub fn as_str(&self) -> &str

Creates a string slice from this MembershipState.

Trait Implementations

impl AsRef<str> for MembershipState

fn as_ref(&self) -> &str

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

impl Clone for MembershipState

fn clone(&self) -> MembershipState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MembershipState

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MembershipState

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for MembershipState

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

Formats the value using the given formatter.

impl<T> From<T> for MembershipState

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

fn from(s: T) -> MembershipState

Converts to this type from the input type.

impl PartialEq for MembershipState

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

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 MembershipState

impl StructuralPartialEq for MembershipState