Struct WebsocketClientConfig 

pub struct WebsocketClientConfig { /* private fields */ }

Implementations

impl ClientConfig

pub fn new<U>(url: U) -> ClientConfig

where U: TryInto<Url>, <U as TryInto<Url>>::Error: Debug,

If invalid URL is passed, this function will panic. In order to handle invalid URL, parse URL on your side, and pass url::Url directly.

pub fn basic( self, username: impl Display, password: impl Display, ) -> ClientConfig

Add ‘basic’ header. Note that additional headers are not supported by the websockets spec, so may not be supported by all implementations.

pub fn bearer(self, token: impl Display) -> ClientConfig

Add ‘bearer’ header. If invalid(outside of visible ASCII characters ranged between 32-127) token is passed, this function will panic. Note that additional headers are not supported by the websockets spec, so may not be supported by all implementations.

pub fn header<K, V>(self, key: K, value: V) -> ClientConfig

where HeaderName: TryFrom<K>, <HeaderName as TryFrom<K>>::Error: Into<Error>, HeaderValue: TryFrom<V>, <HeaderValue as TryFrom<V>>::Error: Into<Error>,

Add custom header. If you suppose the header name or value might be invalid, create http::header::HeaderName and http::header::HeaderValue on your side, and then pass it to this function. Note that additional headers are not supported by the websockets spec, so may not be supported by all implementations.

pub fn query_parameter(self, key: &str, value: &str) -> ClientConfig

Insert query parameters into the connection request URI. Query parameters are supported by the websockets spec, so they will always be available to the connecting server. Decode query parameters in ServerExt::on_connect() with form_urlencoded::parse(request.uri().query().unwrap().as_bytes()) using the form_urlencoded crate.

pub fn max_initial_connect_attempts( self, max_initial_connect_attempts: usize, ) -> ClientConfig

Set the maximum number of connection attempts when starting a client.

Defaults to infinite.

pub fn max_reconnect_attempts( self, max_reconnect_attempts: usize, ) -> ClientConfig

Set the maximum number of attempts when reconnecting.

Defaults to infinite.

pub fn reconnect_interval(self, reconnect_interval: Duration) -> ClientConfig

Set the reconnect interval.

pub fn socket_config(self, socket_config: SocketConfig) -> ClientConfig

Set the socket’s configuration.

pub fn headers(&self) -> &HeaderMap

Get the config’s headers.

pub fn connect_http_request(&self) -> Request<()>

Extract a Websockets HTTP request.

pub fn connect_url(&self) -> &str

Extract the URL request.

This is needed for WASM clients, where building HTTP requests is deferred to the web_sys::Websocket implementation.

Trait Implementations

impl Debug for ClientConfig

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

Formats the value using the given formatter.