Struct websockets::WebSocket

pub struct WebSocket { /* fields omitted */ }

Manages the WebSocket connection; used to connect, send data, and receive data.

Connect directly with WebSocket::connect()...

use websockets::WebSocket;

#[tokio::main]
async fn main() {
    let mut ws = WebSocket::connect("wss://echo.websocket.org/")
        .await
        .unwrap();
}

...or customize the handshake using a WebSocketBuilder obtained from WebSocket::builder().

let mut ws = WebSocket::builder()
    .add_subprotocol("wamp")
    .connect("wss://echo.websocket.org")
    .await
    .unwrap();

Use the WebSocket::send* methods to send frames...

ws.send_text("foo".to_string(), false, true).await.unwrap();

...and WebSocket::receive() to receive frames.

let received_frame = ws.receive().await.unwrap();
let received_msg = received_frame.as_text().unwrap().0.clone();
assert_eq!(received_msg, "foo".to_string()); // echo.websocket.org echoes text frames

Finally, close the connection with WebSocket::close().

let status_code = ws.close(Some((1000, String::new())))
    .await
    .unwrap()
    .as_close()
    .unwrap()
    .0;
assert_eq!(status_code, 1000);

Implementations

impl WebSocket

pub fn builder() -> WebSocketBuilder

Constructs a WebSocketBuilder, which can be used to customize the WebSocket handshake.

pub async fn connect<'_>(url: &'_ str) -> Result<Self, WebSocketError>

Connects to a URL (and performs the WebSocket handshake).

pub async fn send<'_>(&'_ mut self, frame: Frame) -> Result<(), WebSocketError>

Sends an already constructed Frame over the WebSocket connection.

pub async fn receive<'_>(&'_ mut self) -> Result<Frame, WebSocketError>

Receives a Frame over the WebSocket connection.

If the received frame is a Ping frame, a Pong frame will be sent. If the received frame is a Close frame, an echoed Close frame will be sent and the WebSocket will close.

pub async fn send_text<'_>(
    &'_ mut self,
    payload: String,
    continuation: bool,
    fin: bool
) -> Result<(), WebSocketError>

Sends a Text frame over the WebSocket connection, constructed from passed arguments.

pub async fn send_binary<'_>(
    &'_ mut self,
    payload: Vec<u8>,
    continuation: bool,
    fin: bool
) -> Result<(), WebSocketError>

Sends a Binary frame over the WebSocket connection, constructed from passed arguments.

pub async fn close<'_>(
    &'_ mut self,
    payload: Option<(u16, String)>
) -> Result<Frame, WebSocketError>

Sends a Close frame over the WebSocket connection, constructed from passed arguments, and closes the WebSocket connection. This method will attempt to wait for an echoed Close frame, which is returned.

pub async fn send_ping<'_>(
    &'_ mut self,
    payload: Option<Vec<u8>>
) -> Result<(), WebSocketError>

Sends a Ping frame over the WebSocket connection, constructed from passed arguments.

pub async fn send_pong<'_>(
    &'_ mut self,
    payload: Option<Vec<u8>>
) -> Result<(), WebSocketError>

Sends a Pong frame over the WebSocket connection, constructed from passed arguments.

pub async fn shutdown<'_>(&'_ mut self) -> Result<(), WebSocketError>

Shuts down the WebSocket connection without sending a Close frame. It is recommended to use the close() method instead.

pub fn accepted_subprotocol(&self) -> &Option<String>

Returns the subprotocol that was accepted by the server during the handshake, if any.

pub fn handshake_response_headers(&self) -> &Option<Vec<(String, String)>>

Returns the headers that were returned by the server during the handshake.

Trait Implementations

impl Debug for WebSocket

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

Formats the value using the given formatter.