Struct PresenceTracker 

pub struct PresenceTracker {
    local_user: UserId,
    users: HashMap<UserId, UserPresence>,
    stale_timeout: u64,
    pending_delta: Option<PresenceDelta>,
}

Presence tracker for a collaborative session.

Tracks all users’ cursors, selections, and status.

Fields

local_user: UserId

The local user’s ID.

users: HashMap<UserId, UserPresence>

All user presence records.

stale_timeout: u64

Timeout for stale presence (milliseconds).

pending_delta: Option<PresenceDelta>

Pending delta for replication.

Implementations

impl PresenceTracker

pub fn new(local_user: UserId, info: UserInfo) -> Self

Create a new presence tracker.

pub fn local_user(&self) -> &UserId

Get the local user ID.

pub fn set_stale_timeout(&mut self, timeout_ms: u64)

Set the stale timeout.

pub fn local_presence(&self) -> Option<&UserPresence>

Get the local user’s presence.

pub fn set_cursor(&mut self, document_id: impl Into<String>, cursor: Cursor)

Update the local user’s cursor.

pub fn remove_cursor(&mut self, document_id: &str)

Remove the local user’s cursor from a document.

pub fn set_status(&mut self, status: UserStatus)

Set the local user’s status.

pub fn set_state(&mut self, key: impl Into<String>, value: impl Into<String>)

Set local user’s custom state.

pub fn heartbeat(&mut self)

Send a heartbeat to keep presence alive.

pub fn get_user(&self, user_id: &UserId) -> Option<&UserPresence>

Get a user’s presence.

pub fn all_users(&self) -> impl Iterator<Item = &UserPresence> + '_

Get all users.

pub fn online_users(&self) -> impl Iterator<Item = &UserPresence> + '_

Get all online users.

pub fn users_in_document(&self, document_id: &str) -> Vec<&UserPresence>

Get users with cursors in a document.

pub fn cursors_in_document( &self, document_id: &str, ) -> Vec<(&UserPresence, &Cursor)>

Get all cursors in a document (excluding local user).

pub fn online_count(&self) -> usize

Count online users.

pub fn take_delta(&mut self) -> Option<PresenceDelta>

Take the pending delta.

pub fn apply_delta(&mut self, delta: &PresenceDelta)

Apply a delta from another replica.

pub fn cleanup_stale(&mut self) -> Vec<UserId>

Clean up stale presence records.

pub fn leave(&mut self)

Leave (remove local user).

Trait Implementations

impl Clone for PresenceTracker

fn clone(&self) -> PresenceTracker

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PresenceTracker

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

Formats the value using the given formatter.

impl Lattice for PresenceTracker

fn bottom() -> Self

The bottom element (identity for join)

fn join(&self, other: &Self) -> Self

Join operation (least upper bound) Must be commutative, associative, and idempotent

fn partial_cmp_lattice(&self, other: &Self) -> Option<Ordering>

Partial order derived from join: a ≤ b iff a ⊔ b = b

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

Check if self ≤ other in the lattice order

fn join_assign(&mut self, other: &Self)

Join-assign: self = self ⊔ other

impl PartialEq for PresenceTracker

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