Struct Session 

pub struct Session<T: NetworkTransport> { /* private fields */ }

A collaborative session that manages documents and peers.

Implementations

impl<T: NetworkTransport> Session<T>

pub fn new( session_id: impl Into<String>, local_peer_id: PeerId, user_name: impl Into<String>, transport: Arc<T>, ) -> Self

Create a new collaborative session bound to a local peer.

Most applications should use crate::client::Client::create_session instead of calling this directly.

pub fn session_id(&self) -> &str

Return the stable session identifier.

pub fn local_peer_id(&self) -> &PeerId

Return the local peer identifier for this session.

pub fn user_name(&self) -> &str

Return the local user name for this session.

pub fn awareness(&self) -> &Arc<Awareness>

Return the presence/awareness manager.

Use this to set cursor position, selections, and status.

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

Subscribe to session lifecycle events.

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

pub async fn connect(&self) -> Result<(), SdkError>

Connect to the session and broadcast a handshake to peers.

Errors

Returns SdkError::NetworkError if the transport broadcast fails.

pub async fn disconnect(&self) -> Result<(), SdkError>

Disconnect from the session locally.

This emits SessionEvent::Disconnected for local listeners.

pub fn open_text_doc( &self, document_id: impl Into<String>, ) -> Arc<RwLock<TextDoc>>

Create or open a plain-text document by ID.

Returns a shared, lock-protected document handle.

pub fn open_rich_text_doc( &self, document_id: impl Into<String>, ) -> Arc<RwLock<RichTextDoc>>

Create or open a rich-text document by ID.

Returns a shared, lock-protected document handle.

pub fn open_json_doc( &self, document_id: impl Into<String>, ) -> Arc<RwLock<JsonDoc>>

Create or open a JSON document by ID.

Returns a shared, lock-protected document handle.

pub fn close_doc(&self, document_id: &str)

Close a locally opened document handle by ID.

If a document exists in multiple local maps, all matches are removed.

pub fn open_documents(&self) -> Vec<String>

Return all currently opened document IDs across document types.

pub async fn peers(&self) -> Vec<Peer>

Return peers currently connected through the underlying transport.