Struct ClientBuilder 

pub struct ClientBuilder { /* private fields */ }

Builder for creating a WebSocket client.

The resulting client can be reused for multiple connect() calls.

Implementations

impl ClientBuilder

pub fn new() -> Self

Create a new client builder with default options.

pub fn with_options(self, opts: ConnectOptions) -> Self

Replace the builder options wholesale.

pub fn options(&self) -> &ConnectOptions

Return a reference to the current options.

pub fn with_header( self, name: impl Into<String>, value: impl Into<String>, ) -> Self

Add a single header to the connection request.

pub fn with_headers<I, K, V>(self, headers: I) -> Self

where I: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Add multiple headers to the connection request.

pub fn with_limits(self, limits: WebSocketLimits) -> Self

Configure WebSocket message resource limits.

pub fn with_protocol(self, protocol: impl Into<String>) -> Self

Add a single subprotocol.

pub fn with_protocols<I, P>(self, protocols: I) -> Self

where I: IntoIterator<Item = P>, P: Into<String>,

Add multiple subprotocols.

pub fn build(self) -> Client

Build a reusable client.

pub fn with_system_roots(self) -> Result<Client>

Build a client using system roots (no-op in the browser).

pub fn with_server_certificates<I>(self, _chain: I) -> Result<Client>

where I: IntoIterator<Item = Vec<u8>>,

Attempt to configure custom certificates (not supported in the browser).

pub fn dangerous(self) -> DangerousClientBuilder

Enter the “dangerous” builder that can disable certificate verification.

Trait Implementations

impl Clone for ClientBuilder

fn clone(&self) -> ClientBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClientBuilder

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

Formats the value using the given formatter.

impl Default for ClientBuilder

fn default() -> Self

Returns the “default value” for a type.