Struct WsClientConfig 

pub struct WsClientConfig { /* private fields */ }

Configuration for a WebSocket client connection.

Store this value in SharedCfg and pass the resulting configuration to WsClient::new.

Implementations

impl WsClientConfig

pub fn new() -> WsClientConfig

Creates a WebSocket client configuration with default values.

pub fn set_address(self, addr: SocketAddr) -> Self

Sets the server socket address.

This address is used instead of resolving the URI host name.

pub fn set_protocols<U, V>(self, protos: U) -> Result<Self, HttpError>

where U: IntoIterator<Item = V>, V: AsRef<str>,

Sets the WebSocket subprotocols offered to the server.

This replaces the current Sec-WebSocket-Protocol header. An empty iterator removes the header.

Errors

Returns HttpError if a protocol is not a valid HTTP token or the resulting list is not a valid HTTP header value.

pub fn set_cookie<C>(self, cookie: C) -> Self

where C: Into<Cookie<'static>>,

Adds a cookie to the opening handshake.

pub fn set_origin<V, E>(self, origin: V) -> Result<Self, HttpError>

where HeaderValue: TryFrom<V, Error = E>, HttpError: From<E>,

Sets the Origin header for the opening handshake.

pub fn set_max_frame_size(self, size: usize) -> Self

Sets the maximum accepted frame payload size.

The default is 64 KiB.

pub fn set_server_mode(self) -> Self

Configures the connection to use server-side masking rules.

By default, the client masks outgoing frames and expects unmasked incoming frames. Server mode reverses those rules.

pub fn set_header<K, V>(self, key: K, value: V) -> Result<Self, HttpError>

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

Sets a header for the opening handshake.

This replaces any existing value with the same name.

pub fn set_header_if_none<K, V>( self, key: K, value: V, ) -> Result<Self, HttpError>

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

Sets a handshake header if it is not already present.

pub fn set_basic_auth( self, username: impl Display, password: Option<&str>, ) -> Result<Self, HttpError>

Sets the HTTP Basic authentication header.

pub fn set_bearer_auth(self, token: impl Display) -> Result<Self, HttpError>

Sets the HTTP bearer authentication header.

pub fn set_handshake_timeout(self, timeout: impl Into<Millis>) -> Self

Sets the opening-handshake timeout.

The timeout covers sending the upgrade request and receiving the response after a connection has been established. The default is 5 seconds. A zero duration disables the timeout.

pub fn set_close_timeout(self, timeout: impl Into<Millis>) -> Self

Sets the closing-handshake timeout.

After sending a close frame, the client waits this long for the peer’s close response before shutting down the connection. The default is 5 seconds. A zero duration disables the timeout.

Trait Implementations

impl Configuration for WsClientConfig

const NAME: &str = "WebSocket client configuration"

Human-readable configuration name used in diagnostics.

fn ctx(&self) -> &CfgContext

Returns the shared context associated with this value.

fn set_ctx(&mut self, ctx: CfgContext)

Associates this value with a shared configuration context.

impl Debug for WsClientConfig

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

Formats the value using the given formatter.

impl Default for WsClientConfig

fn default() -> Self

Returns the “default value” for a type.