Struct WebSocketContext 

pub struct WebSocketContext {
    pub request: BootRequest,
    pub gateway_path: String,
    pub event: String,
    pub namespace: Option<String>,
    pub module_name: Option<String>,
    /* private fields */
}

Context available to WebSocket guards and interceptors.

Fields

request: BootRequest

gateway_path: String

event: String

namespace: Option<String>

module_name: Option<String>

Implementations

impl WebSocketContext

pub fn server(&self) -> WebSocketGatewayServer

pub fn execution_context(&self) -> &ExecutionContext

pub fn into_execution_context(self) -> ExecutionContext

Methods from Deref<Target = ExecutionContext>

pub fn protocol(&self) -> ExecutionProtocol

pub fn websocket_context(&self) -> Option<&WebSocketExecutionContext>

pub fn transport_context(&self) -> Option<&TransportExecutionContext>

pub fn metadata_value(&self, key: &str) -> Option<&Value>

pub fn metadata_as<T>(&self, key: &str) -> Result<Option<T>>

where T: DeserializeOwned,

Trait Implementations

impl Clone for WebSocketContext

fn clone(&self) -> WebSocketContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WebSocketContext

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

Formats the value using the given formatter.

impl Deref for WebSocketContext

type Target = ExecutionContext

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.