Enum PresenceState 

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

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

👎Deprecated:

Deprecated when MSC4532 is enabled, use a revised state instead

Connected to the service.

Unavailable

👎Deprecated:

Deprecated when MSC4532 is enabled, use a revised state instead

Connected to the service but not available for chat.

Active

Available on crate feature unstable-msc4532 only.

The user is available to reply.

This uses the unstable prefix defined in MSC4532.

Idle

Available on crate feature unstable-msc4532 only.

The user has a connected client and may reply (potentially unreachable).

This uses the unstable prefix defined in MSC4532.

Busy

Available on crate feature unstable-msc4532 only.

The user is unavailable to reply (fully unreachable).

This uses the unstable prefix defined in MSC4532.

Implementations

impl PresenceState

pub fn as_str(&self) -> &str

Creates a string slice from this PresenceState.

impl PresenceState

pub fn as_msc4532_state(&self, currently_active: bool) -> Self

Available on crate feature unstable-msc4532 only.

If this PresenceState is a legacy (non-MSC4532) state, return the equivalent MSC4532 state.

This uses the behavior map as defined in the proposal.

pub fn as_legacy_state(&self) -> Self

Available on crate feature unstable-msc4532 only.

If this PresenceState is an MSC4532 state, return the equivalent legacy (non-MSC4532) state.

This uses the behavior map as defined in the proposal.

pub fn is_msc4532_state(&self) -> bool

Available on crate feature unstable-msc4532 only.

Returns true if this PresenceState is a MSC4532 state.

This uses the behavior map as defined in the proposal.

pub fn currently_active(&self) -> bool

Available on crate feature unstable-msc4532 only.

Return a reasonable currently_active value for 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) -> Self

Returns a duplicate 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() -> Self

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 Eq for PresenceState

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 Ord for PresenceState

fn cmp(&self, other: &Self) -> 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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for PresenceState

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for PresenceState

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

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.