Struct simple_websockets::Responder

pub struct Responder { /* private fields */ }

Sends outgoing messages to a websocket. Every connected websocket client has a corresponding Responder.

Responders can be safely cloned and sent across threads, to be used in a multi-producer single-consumer paradigm.

If a Reponder is dropped while its client is still connected, the connection will be automatically closed. If there are multiple clones of a Responder, The client will not be disconnected until the last Responder is dropped.

Implementations

impl Responder

pub fn send(&self, message: Message) -> bool

Sends a message to the client represented by this Responder.

Returns true if the message was sent, or false if it wasn’t sent (because the client is disconnected).

Note that this doesn’t need a mutable reference to self.

pub fn close(&self)

Closes this client’s connection.

Note that this doesn’t need a mutable reference to self.

pub fn client_id(&self) -> u64

The id of the client that this Responder is connected to.

Trait Implementations

impl Clone for Responder

fn clone(&self) -> Responder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Responder

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

Formats the value using the given formatter.