Struct WebSocketAuthConfig

pub struct WebSocketAuthConfig {
    pub require_handshake_auth: bool,
    pub allow_post_connect_auth: bool,
    pub supported_methods: Vec<WebSocketAuthMethod>,
    pub enable_per_message_auth: bool,
    pub auth_subprotocol: Option<String>,
    pub auth_timeout_secs: u64,
}

Configuration for WebSocket authentication

Fields

require_handshake_auth: bool

Require authentication during WebSocket handshake

allow_post_connect_auth: bool

Allow authentication after connection (first message)

supported_methods: Vec<WebSocketAuthMethod>

Supported authentication methods

enable_per_message_auth: bool

Enable per-message authentication

auth_subprotocol: Option<String>

WebSocket subprotocol for authentication

auth_timeout_secs: u64

Connection timeout for authentication (seconds)

Implementations

impl WebSocketAuthConfig

Helper for creating WebSocket authentication configuration

pub fn secure() -> Self

Create a secure configuration

pub fn flexible() -> Self

Create a flexible configuration

pub fn development() -> Self

Create a development-friendly configuration

Trait Implementations

impl Clone for WebSocketAuthConfig

fn clone(&self) -> WebSocketAuthConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WebSocketAuthConfig

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

Formats the value using the given formatter.

impl Default for WebSocketAuthConfig

fn default() -> Self

Returns the “default value” for a type.