Struct WebSocketGatewayDefinition 

pub struct WebSocketGatewayDefinition { /* private fields */ }

Framework-neutral WebSocket gateway definition.

Implementations

impl WebSocketGatewayDefinition

pub fn new(path: impl Into<String>) -> Result<Self>

pub fn path(&self) -> &str

pub fn path_shape(&self) -> String

pub fn module_name(&self) -> Option<&str>

pub fn events(&self) -> Vec<&str>

pub fn matches_path(&self, path: &str) -> bool

pub fn path_params( &self, path: &str, ) -> Result<Option<BTreeMap<String, String>>>

pub fn subscribe<H, Fut, R>( self, event: impl Into<String>, handler: H, ) -> Result<Self>

where H: Fn(WebSocketMessage) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<R>> + Send + 'static, R: IntoWebSocketReply + Send + 'static,

pub fn with_pipe<P>(self, pipe: P) -> Self

where P: WebSocketPipe,

pub fn with_guard<G>(self, guard: G) -> Self

where G: WebSocketGuard,

pub fn with_execution_guard<G>(self, guard: G) -> Self

where G: Guard,

pub fn with_interceptor<I>(self, interceptor: I) -> Self

where I: WebSocketInterceptor,

pub fn with_execution_interceptor<I>(self, interceptor: I) -> Self

where I: ExecutionInterceptor,

pub fn connect( &self, request: BootRequest, ) -> Result<WebSocketGatewayConnection>

pub async fn dispatch( &self, request: BootRequest, message: WebSocketMessage, ) -> Result<Option<WebSocketMessage>>

Trait Implementations

impl Clone for WebSocketGatewayDefinition

fn clone(&self) -> WebSocketGatewayDefinition

Returns a duplicate of the value.

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

Performs copy-assignment from source.