Struct WebsocketCommands 

pub struct WebsocketCommands { /* private fields */ }

A command buffer returned from a websocket callback.

Implementations

impl WebsocketCommands

pub fn new() -> Self

Constructs a new websocket command buffer.

pub fn with_send<T: Into<WebsocketMessage>>(message: T) -> Self

Constructs a new websocket command buffer to send message.

Examples found in repository

examples/server.rs (line 41)

    async fn websocket_handle(
        &mut self,
        message: WebsocketMessage,
    ) -> Result<Option<WebsocketCommands>, ExitReason> {
        match message {
            WebsocketMessage::Text(text) => {
                tracing::info!(handler = ?Process::current(), message = ?text.as_str(), "Got message");

                // Echo the command back to the client.
                Ok(Some(WebsocketCommands::with_send(text.as_str())))
            }
            _ => {
                // Hydra websockets automatically responds to ping requests.
                Ok(None)
            }
        }
    }

pub fn with_close<T: Into<String>>(code: CloseCode, reason: T) -> Self

Constructs a new websocket command buffer to close the websocket gracefully.

pub fn send<T: Into<WebsocketMessage>>(&mut self, message: T)

Sends the message to the websocket client.

pub fn close<T: Into<String>>(&mut self, code: CloseCode, reason: T)

Gracefully close the websocket with the given code and reason.

Trait Implementations

impl Default for WebsocketCommands

fn default() -> Self

Returns the “default value” for a type.