Struct Config 

#[non_exhaustive]
pub struct Config<S> {
    pub guard: OnDisconnectGuard,
    pub stream: RelayedStream<S>,
    pub write_timeout: Duration,
    pub channel_capacity: usize,
    pub protocol_version: ProtocolVersion,
    /* private fields */
}

Available on crate feature server only.

Configuration for a client connection.

Generic over the stream type to support different WebSocket implementations.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

guard: OnDisconnectGuard

Reports the disconnect once the connection ends.

Also the owner of this connection’s EndpointId and ConnectionId.

stream: RelayedStream<S>

The relayed stream connection

write_timeout: Duration

Write timeout for the client connection

channel_capacity: usize

Channel capacity for internal message queues

protocol_version: ProtocolVersion

Protocol version negotiated for this client

Implementations

impl<S> Config<S>

pub fn new( guard: OnDisconnectGuard, stream: RelayedStream<S>, protocol_version: ProtocolVersion, ) -> Self

Creates a new config with sensible default values for write_timeout and channel_capacity.

The endpoint and connection ids are taken from guard.

Trait Implementations

impl<S: Debug> Debug for Config<S>

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

Formats the value using the given formatter.