Struct WebSocketBuilder

pub struct WebSocketBuilder { /* private fields */ }

Builder for connecting a WebSocket.

Implementations

impl WebSocketBuilder

pub fn new(url: impl AsRef<str>) -> Self

Creates a new WebSocket builder that will connect to the specified URL.

pub fn set_interface(&mut self, interface: Interface)

Sets the WebSocket browser interface to use.

If unset, the stream-based interface is preferred when available.

pub fn set_protocols<P>(&mut self, protocols: impl IntoIterator<Item = P>)

where P: AsRef<str>,

Sets the sub-protocol(s) that the client would like to use.

Subprotocols may be selected from the IANA WebSocket Subprotocol Name Registry or may be custom names jointly understood by the client and the server. A single server can implement multiple WebSocket sub-protocols, and handle different types of interactions depending on the specified value.

If protocols is included, the connection will only be established if the server reports that it has selected one of these sub-protocols.

pub fn set_send_buffer_size(&mut self, send_buffer_size: usize)

Sets the maximum send buffer size in bytes.

This only affects the standard WebSocket interface.

If the maximum send buffer size is reached, all sending function stop accepting data until the send buffer size falls below the specified size.

pub fn set_receive_buffer_size(&mut self, receive_buffer_size: usize)

Sets the maximum receive buffer size in bytes.

This only affects the standard WebSocket interface.

If the maximum receive buffer size is reached, the WebSocket is closed and an error is returned when trying to read from it.

pub async fn connect(self) -> Result<WebSocket>

Establishes the WebSocket connection.

Trait Implementations

impl Clone for WebSocketBuilder

fn clone(&self) -> WebSocketBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WebSocketBuilder

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

Formats the value using the given formatter.