Struct UserPresence 

pub struct UserPresence {
    pub user_id: UserId,
    pub info: UserInfo,
    pub status: UserStatus,
    pub cursors: HashMap<String, Cursor>,
    pub state: HashMap<String, String>,
    pub last_updated: u64,
    pub timestamp: u64,
}

Presence data for a single user.

Fields

user_id: UserId

The user ID.

info: UserInfo

User information.

status: UserStatus

Current status.

cursors: HashMap<String, Cursor>

Cursor positions by document ID.

state: HashMap<String, String>

Custom user state data.

last_updated: u64

Last update timestamp (milliseconds since epoch).

timestamp: u64

Lamport timestamp for ordering.

Implementations

impl UserPresence

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

Create new presence for a user.

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

Update the cursor for a document.

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

Remove the cursor for a document.

pub fn get_cursor(&self, document_id: &str) -> Option<&Cursor>

Get the cursor for a document.

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

Set the status.

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

Set custom state data.

pub fn get_state(&self, key: &str) -> Option<&String>

Get custom state data.

pub fn is_stale(&self, timeout_ms: u64) -> bool

Check if this presence is stale (not updated within timeout).

Trait Implementations

impl Clone for UserPresence

fn clone(&self) -> UserPresence

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UserPresence

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for UserPresence

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for UserPresence

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for UserPresence