Struct trillium_channels::ChannelClient

pub struct ChannelClient { /* private fields */ }

Communicate with the connected client.

Note that although each client is unique and represents a specific websocket connection, the ChannelClient can be cloned and moved elsewhere if needed and any updates to the topic subscriptions will be kept synchronized across clones.

Implementations

impl ChannelClient

pub fn broadcast(&self, event: impl Into<ChannelEvent>)

Send a ChannelEvent to all connected clients. Note that these messages will only reach clients that subscribe to the event’s topic.

pub async fn send_event(&self, event: impl Into<ChannelEvent>)

Send a ChannelEvent to this specific client. Note that this message will only be received if the client subscribes to the event’s topic.

pub async fn reply_ok(&self, event: &ChannelEvent, payload: &impl Serialize)

Send an ok reply in reference to the provided ChannelEvent with the provided response payload.

Note that this sets the event as "phx_reply" and the payload as {"status": "ok", "response": response }, as well as setting the reference field.

pub async fn reply_error(&self, event: &ChannelEvent, error: &impl Serialize)

Send an error reply in reference to the provided ChannelEvent with the provided response payload.

Note that this sets the event as "phx_error" as well as setting the reference field.

pub async fn allow_join(&self, event: &ChannelEvent, payload: &impl Serialize)

Join a topic, sending an ok reply with the provided optional value. This sends an ok reply to the client as well as adding the topic to the client’s subscriptions.

Use &() as the payload if no payload is needed.

pub async fn allow_leave(&self, event: &ChannelEvent, payload: &impl Serialize)

Leave a topic as requested by the provided channel event, including the optional payload. This sends an ok reply to the client as well as removing the channel from the client’s subscriptions.

Use &() as the payload if no payload is needed.

pub fn subscriptions(&self) -> &Subscriptions

Borrow this client’s subscriptions

Trait Implementations

impl Clone for ChannelClient

fn clone(&self) -> ChannelClient

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ChannelClient

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

Formats the value using the given formatter.