Struct Client 

pub struct Client { /* private fields */ }

A connected relay client.

Implementations

impl Client

pub async fn connect(addr: &str) -> Result<Self, SyncError>

Connect to a relay server.

pub fn builder() -> ClientBuilder

Start building a client.

pub fn client_id(&self) -> Option<Uuid>

Get the client’s UUID assigned by the server.

Returns None before the first successful join + recv (the server assigns the ID and sends it in the Joined event).

pub async fn join( &mut self, room_id: &str, data: Option<&[u8]>, ) -> Result<(), SyncError>

Join a room. If room does not exist, returns SyncError::RoomNotFound

pub async fn echo_test(&mut self, data: &[u8]) -> Result<(), SyncError>

An Echo check that can be performed at any time to verify the connection is alive and measure latency. Prefers raw bytes to avoid serialization overhead and perform after Client::join, limit at max_payload

pub async fn leave(&mut self) -> Result<(), SyncError>

Leave the current room.

pub async fn ping(&mut self) -> Result<(), SyncError>

Send a ping (keep-alive).

pub async fn broadcast(&mut self, data: &[u8]) -> Result<(), SyncError>

Broadcast raw bytes to all peers in the current room.

pub async fn recv(&mut self) -> Result<Option<ServerEvent>, SyncError>

Receive the next server event. Ping/pong keepalive is handled internally Returns Ok(None) on clean disconnect.