Struct WsAuthConfig 

pub struct WsAuthConfig {
    pub extractor: TokenExtractor,
    pub validator: Arc<dyn TokenValidator>,
    pub required: bool,
}

Configuration for WebSocket authentication

Fields

extractor: TokenExtractor

Token extractor configuration

validator: Arc<dyn TokenValidator>

Token validator

required: bool

Whether authentication is required (if false, missing tokens are allowed)

Implementations

impl WsAuthConfig

pub fn new<V: TokenValidator + 'static>(validator: V) -> Self

Create a new authentication configuration with a validator

pub fn extractor(self, extractor: TokenExtractor) -> Self

Set the token extractor

pub fn required(self, required: bool) -> Self

Set whether authentication is required

pub async fn authenticate<B>( &self, req: &Request<B>, ) -> Result<Option<Claims>, AuthError>

Extract and validate a token from a request

Trait Implementations

impl Clone for WsAuthConfig

fn clone(&self) -> WsAuthConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WsAuthConfig

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

Formats the value using the given formatter.