Struct ClientConfig 

pub struct ClientConfig {
    pub max_frame_size: usize,
    pub max_message_size: usize,
    pub handshake_timeout: Duration,
    pub idle_timeout: Duration,
    pub compression: CompressionConfig,
    pub tls: Option<TlsConfig>,
    pub user_agent: String,
    pub origin: Option<String>,
    pub protocols: Vec<String>,
    pub headers: Vec<(String, String)>,
}

Client configuration

Fields

max_frame_size: usize

Maximum frame size in bytes

max_message_size: usize

Maximum message size in bytes

handshake_timeout: Duration

Handshake timeout

idle_timeout: Duration

Idle timeout

compression: CompressionConfig

Compression configuration

tls: Option<TlsConfig>

TLS configuration

user_agent: String

User agent string

origin: Option<String>

Origin header

protocols: Vec<String>

WebSocket subprotocols

headers: Vec<(String, String)>

Custom headers

Implementations

impl ClientConfig

pub fn validate(&self) -> Result<()>

Validate the configuration

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

Set maximum frame size

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

Set maximum message size

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

Set handshake timeout

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

Set idle timeout

pub fn user_agent(self, agent: String) -> Self

Set user agent

pub fn origin(self, origin: String) -> Self

Set origin

pub fn add_protocol(self, protocol: String) -> Self

Add a subprotocol

pub fn add_header(self, name: String, value: String) -> Self

Add a custom header

pub fn tls(self, config: TlsConfig) -> Self

Set TLS configuration

Trait Implementations

impl Clone for ClientConfig

fn clone(&self) -> ClientConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClientConfig

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

Formats the value using the given formatter.

impl Default for ClientConfig

fn default() -> Self

Returns the “default value” for a type.