Struct WsClientBuilder

pub struct WsClientBuilder { /* private fields */ }

A WsClientBuilder can be used to create a HttpClient with custom configuration.

Implementations

impl WsClientBuilder

pub fn new() -> Self

Creates a new WsClientBuilder.

This is the same as WsClient::builder().

pub fn basic_auth<U, P>(self, username: U, password: Option<P>) -> Self

where U: Display, P: Display,

Enables basic authentication.

pub fn bearer_auth<T>(self, token: T) -> Self

where T: Display,

Enables bearer authentication.

pub fn header(self, name: HeaderName, value: HeaderValue) -> Self

Adds a Header for handshake request.

pub fn headers(self, headers: HeaderMap) -> Self

Adds Headers for handshake request.

pub fn max_concurrent_request_capacity(self, capacity: usize) -> Self

Sets the max channel capacity of sending request concurrently.

Default is 256.

pub fn max_capacity_per_subscription(self, capacity: usize) -> Self

Sets the max channel capacity of every subscription stream.

Default is 64.

pub fn timeout(self, timeout: Duration) -> Self

Enables a request timeout.

The timeout is applied from when the request starts connecting until the response body has finished.

Default is no timeout.

pub async fn build(self, url: impl Into<String>) -> Result<WsClient, WsError>

Returns a WsClient that uses this WsClientBuilder configuration.

Trait Implementations

impl Debug for WsClientBuilder

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

Formats the value using the given formatter.

impl Default for WsClientBuilder

fn default() -> Self

Returns the “default value” for a type.