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 session.

pub fn session_id(&self) -> &str

Get the session ID.

pub fn local_peer_id(&self) -> &PeerId

Get the local peer ID.

pub fn user_name(&self) -> &str

Get the user name.

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

Get the awareness manager.

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

Subscribe to session events.

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

Connect to the session (announce presence to peers).

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

Disconnect from the session.

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

Create or open a text document.

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

Create or open a rich text document.

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

Create or open a JSON document.

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

Close a document.

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

Get list of open document IDs.

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

Get connected peers.