Skip to main content

Awareness

Struct Awareness 

Source
pub struct Awareness { /* private fields */ }
Expand description

Awareness manager tracking all client states

Implementations§

Source§

impl Awareness

Source

pub fn new(client_id: String) -> Self

Create new awareness instance

Source

pub fn client_id(&self) -> &str

Get the local client ID

Source

pub fn get_states(&self) -> &HashMap<String, AwarenessState>

Get all current client states

Source

pub fn get_state(&self, client_id: &str) -> Option<&AwarenessState>

Get state for a specific client

Source

pub fn get_local_state(&self) -> Option<&AwarenessState>

Get local client’s state

Source

pub fn set_local_state(&mut self, state: Value) -> AwarenessUpdate

Set local client’s state (returns update to broadcast)

Source

pub fn apply_update(&mut self, update: AwarenessUpdate)

Apply remote awareness update

Source

pub fn remove_stale_clients(&mut self, timeout: Duration) -> Vec<String>

Remove clients that haven’t updated within timeout Returns list of removed client IDs

Source

pub fn create_leave_update(&self) -> AwarenessUpdate

Create update to signal local client leaving

Source

pub fn client_count(&self) -> usize

Get number of online clients (including self)

Source

pub fn other_client_count(&self) -> usize

Get number of online clients excluding self

Trait Implementations§

Source§

impl Debug for Awareness

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.