Struct WebSocket

pub struct WebSocket<S, H> { /* private fields */ }

endpoint/middleware handler for websockets in tide

This can either be used as a middleware or as an endpoint. Regardless of which approach is taken, the handler function provided to WebSocket::new is only called if the request correctly negotiates an upgrade to the websocket protocol.

As a middleware

If used as a middleware, the endpoint will be executed if the request is not a websocket upgrade.

Example

use async_std::prelude::*;
use tide_websockets::{Message, WebSocket};

#[async_std::main]
async fn main() -> Result<(), std::io::Error> {
    let mut app = tide::new();

    app.at("/ws")
        .with(WebSocket::new(|_request, mut stream| async move {
            while let Some(Ok(Message::Text(input))) = stream.next().await {
                let output: String = input.chars().rev().collect();

                stream
                    .send_string(format!("{} | {}", &input, &output))
                    .await?;
            }

            Ok(())
        }))
       .get(|_| async move { Ok("this was not a websocket request") });

    app.listen("127.0.0.1:8080").await?;
    Ok(())
}

As an endpoint

If used as an endpoint but the request is not a websocket request, tide will reply with a 426 Upgrade Required status code.

example

use async_std::prelude::*;
use tide_websockets::{Message, WebSocket};

#[async_std::main]
async fn main() -> Result<(), std::io::Error> {
    let mut app = tide::new();

    app.at("/ws")
        .get(WebSocket::new(|_request, mut stream| async move {
            while let Some(Ok(Message::Text(input))) = stream.next().await {
                let output: String = input.chars().rev().collect();

                stream
                    .send_string(format!("{} | {}", &input, &output))
                    .await?;
            }

            Ok(())
        }));

    app.listen("127.0.0.1:8080").await?;
    Ok(())
}

Implementations

impl<S, H, Fut> WebSocket<S, H>

where S: Send + Sync + Clone + 'static, H: Fn(Request<S>, WebSocketConnection) -> Fut + Sync + Send + 'static, Fut: Future<Output = Result<(), Error>> + Send + 'static,

pub fn new(handler: H) -> WebSocket<S, H>

Build a new WebSocket with a handler function that

Trait Implementations

impl<S, H> Debug for WebSocket<S, H>

where S: Debug, H: Debug,

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

Formats the value using the given formatter.

impl<H, S, Fut> Endpoint<S> for WebSocket<S, H>

where H: Fn(Request<S>, WebSocketConnection) -> Fut + Sync + Send + 'static, Fut: Future<Output = Result<(), Error>> + Send + 'static, S: Send + Sync + Clone + 'static,

fn call<'life0, 'async_trait>( &'life0 self, req: Request<S>, ) -> Pin<Box<dyn Future<Output = Result<Response, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, WebSocket<S, H>: 'async_trait,

Invoke the endpoint within the given context

impl<H, S, Fut> Middleware<S> for WebSocket<S, H>

where H: Fn(Request<S>, WebSocketConnection) -> Fut + Sync + Send + 'static, Fut: Future<Output = Result<(), Error>> + Send + 'static, S: Send + Sync + Clone + 'static,

fn handle<'life0, 'life1, 'async_trait>( &'life0 self, req: Request<S>, next: Next<'life1, S>, ) -> Pin<Box<dyn Future<Output = Result<Response, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, WebSocket<S, H>: 'async_trait,

Asynchronously handle the request, and return a response.

fn name(&self) -> &str

Set the middleware’s name. By default it uses the type signature.