Struct Client 

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

The main MDCS client for collaborative editing.

The client manages sessions, documents, and network connections.

Example

use mdcs_sdk::{Client, ClientConfig};

// Create a client
let config = ClientConfig {
    user_name: "Alice".to_string(),
    ..Default::default()
};
let client = Client::new_with_memory_transport(config);

// Create a session
let session = client.create_session("my-session");

// Open a document
let doc = session.open_text_doc("shared-doc");
doc.write().insert(0, "Hello, world!");

Implementations

impl Client<MemoryTransport>

pub fn new_with_memory_transport(config: ClientConfig) -> Self

Create a new client backed by MemoryTransport.

This constructor is ideal for tests, local demos, and examples where all peers run in the same process.

impl<T: NetworkTransport> Client<T>

pub fn new(peer_id: PeerId, transport: Arc<T>, config: ClientConfig) -> Self

Create a new client with a custom transport implementation.

Use this constructor when integrating with a real networking backend (WebSocket, QUIC, custom RPC, etc.).

pub fn peer_id(&self) -> &PeerId

Return the unique identifier of this local peer.

pub fn user_name(&self) -> &str

Return the configured local user name.

pub fn transport(&self) -> &Arc<T>

Return the transport used by this client.

pub fn create_session(&self, session_id: impl Into<String>) -> Arc<Session<T>>

Create or fetch a collaborative session by ID.

If the session already exists, this returns the same shared instance.

pub fn get_session(&self, session_id: &str) -> Option<Arc<Session<T>>>

Get an existing session if it has already been created on this client.

pub fn close_session(&self, session_id: &str)

Close a local session handle and remove it from the client cache.

This does not notify remote peers directly; use higher-level app signaling if your protocol requires explicit leave semantics.

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

List all currently active local session IDs.

pub async fn connect_peer(&self, peer_id: &PeerId) -> Result<(), SdkError>

Establish a transport-level connection to a peer.

Errors

Returns SdkError::ConnectionFailed if the underlying transport cannot connect to the target peer.

pub async fn disconnect_peer(&self, peer_id: &PeerId) -> Result<(), SdkError>

Disconnect from a peer.

Errors

Returns SdkError::NetworkError if the transport reports a failure while disconnecting.

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

Return the current list of connected peers reported by the transport.