Struct websockets::WebSocketBuilder

pub struct WebSocketBuilder { /* fields omitted */ }

A builder used to customize the WebSocket handshake.

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

Implementations

impl WebSocketBuilder

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

Builds a WebSocket using this builder, then connects to a URL (and performs the WebSocket handshake).

After calling this method, no more methods should be called on this builder.

pub fn add_header(&mut self, header_name: &str, header_value: &str) -> &mut Self

Adds a header to be sent in the WebSocket handshake.

pub fn remove_header(&mut self, header_name: &str) -> &mut Self

Removes a header which would be sent in the WebSocket handshake.

pub fn add_subprotocol(&mut self, subprotocol: &str) -> &mut Self

Adds a subprotocol to the list of subprotocols to be sent in the WebSocket handshake. The server may select a subprotocol from this list. If it does, the selected subprotocol can be found using the WebSocket::accepted_subprotocol() method.

pub fn remove_subprotocol(&mut self, subprotocol: &str) -> &mut Self

Removes a subprotocol from the list of subprotocols that would be sent in the WebSocket handshake.

Trait Implementations

impl Debug for WebSocketBuilder

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

Formats the value using the given formatter.