Struct Client 

pub struct Client {
    pub id: ClientId,
    pub metadata: ClientMetadata,
    /* private fields */
}

A connected WebSocket client.

Fields

id: ClientId

Unique client identifier.

metadata: ClientMetadata

Connection metadata.

Implementations

impl Client

pub fn new(id: ClientId, sender: UnboundedSender<String>) -> Self

Create a new client with a message sender.

pub fn send(&self, message: String) -> Result<(), RealtimeError>

Send a message to this client.

pub fn subscribe(&self, channel: Channel) -> Result<bool, RealtimeError>

Subscribe to a channel.

pub fn unsubscribe(&self, channel: &Channel) -> bool

Unsubscribe from a channel.

pub fn is_subscribed(&self, channel: &Channel) -> bool

Check if subscribed to a channel.

pub fn matches_event(&self, event_channel: &str) -> bool

Check if any subscription matches an event channel.

pub fn subscription_count(&self) -> usize

Get subscription count.

pub fn clear_subscriptions(&self)

Clear all subscriptions.

Trait Implementations

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.