Struct PresenceState 

pub struct PresenceState(pub BTreeMap<String, Presence>);

Current Phoenix Presence entries keyed by application-defined presence key.

Tuple Fields

0: BTreeMap<String, Presence>

Implementations

impl PresenceState

pub fn from_value(value: &Value) -> Result<Self, PresenceError>

Decodes a presence_state JSON object.

pub fn get(&self, key: &str) -> Option<&Presence>

Returns the Presence entry for key.

pub fn iter(&self) -> impl Iterator<Item = (&str, &Presence)>

Iterates over presence keys and entries in key order.

pub fn is_empty(&self) -> bool

Returns whether the state contains no presence entries.

Trait Implementations

impl Clone for PresenceState

fn clone(&self) -> PresenceState

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() -> PresenceState

Returns the “default value” for a 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 StructuralPartialEq for PresenceState