Crate reqwest_websocket

Provides wrappers for reqwest to enable websocket connections.

Example

// Extends the reqwest::RequestBuilder to allow websocket upgrades
use reqwest_websocket::RequestBuilderExt;

// create a GET request, upgrade it and send it.
let response = Client::default()
    .get("wss://echo.websocket.org/")
    .upgrade() // prepares the websocket upgrade.
    .send()
    .await?;

// turn the response into a websocket stream
let mut websocket = response.into_websocket().await?;

// the websocket implements `Sink<Message>`.
websocket.send(Message::Text("Hello, World".into())).await?;

// the websocket is also a `TryStream` over `Message`s.
while let Some(message) = websocket.try_next().await? {
    match message {
        Message::Text(text) => println!("{text}"),
        _ => {}
    }
}

Structs

• UpgradeResponse
  The server’s response to the websocket upgrade request.
• UpgradedRequestBuilder
  Wrapper for RequestBuilder that performs the websocket handshake when sent.
• WebSocket
  A websocket connection

Enums

• Error
  Errors returned by reqwest_websocket
• HandshakeError
  Error during Websocket handshake
• Message
  A websocket message, which can be a text string or binary data.

Traits

• RequestBuilderExt
  Trait that extends reqwest::RequestBuilder with an upgrade method.

Functions

• websocket
  Opens a websocket at the specified URL.