Struct Awareness 

pub struct Awareness {
    local_user_id: String,
    local_user_name: String,
    local_color: String,
    tracker: Arc<RwLock<PresenceTracker>>,
    event_tx: Sender<AwarenessEvent>,
}

Awareness manager for a document or session.

Fields

local_user_id: String

local_user_name: String

local_color: String

tracker: Arc<RwLock<PresenceTracker>>

event_tx: Sender<AwarenessEvent>

Implementations

impl Awareness

pub fn new( local_user_id: impl Into<String>, local_user_name: impl Into<String>, ) -> Self

Create a new awareness manager for a local user.

The local user is initialized with a default color and an online presence record in the underlying tracker.

pub fn local_user_id(&self) -> &str

Return the local user identifier.

pub fn local_user_name(&self) -> &str

Return the local user display name.

pub fn set_cursor(&self, document_id: &str, position: usize)

Set the local user’s cursor position for a document.

Emits AwarenessEvent::CursorMoved.

pub fn set_selection(&self, document_id: &str, start: usize, end: usize)

Set the local user’s selection range for a document.

Emits AwarenessEvent::CursorMoved.

pub fn set_status(&self, status: UserStatus)

Update the local user’s presence status.

pub fn get_users(&self) -> Vec<UserPresenceInfo>

Return a snapshot of all known users and cursor states.

pub fn get_cursors(&self, document_id: &str) -> Vec<CursorInfo>

Return cursor information for users active in a specific document.

pub fn get_local_color(&self) -> &str

Return the local user’s assigned color string.

pub fn subscribe(&self) -> Receiver<AwarenessEvent>

Subscribe to awareness updates.

This uses a broadcast channel; late subscribers receive only future events.

pub fn cleanup_stale(&self)

Remove stale user entries that have not been active recently.