Enum ruma_common::presence::PresenceState

#[non_exhaustive]
pub enum PresenceState {
    Offline,
    Online,
    Unavailable,
}

A description of a user’s connectivity and availability for chat.

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.

Offline

Disconnected from the service.

Online

Connected to the service.

Unavailable

Connected to the service but not available for chat.

Implementations

impl PresenceState

pub fn as_str(&self) -> &str

Creates a string slice from this PresenceState.

Trait Implementations

impl AsRef<str> for PresenceState

fn as_ref(&self) -> &str

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

impl Clone for PresenceState

fn clone(&self) -> PresenceState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PresenceState

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

Formats the value using the given formatter.

impl Default for &PresenceState

fn default() -> Self

Returns the “default value” for a type.

impl Default for PresenceState

fn default() -> PresenceState

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PresenceState

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PresenceState

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

Formats the value using the given formatter.

impl<T> From<T> for PresenceState

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

fn from(s: T) -> Self

Converts to this type from the input type.

impl PartialEq for PresenceState

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

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 PresenceState

impl StructuralPartialEq for PresenceState