Struct WebSocketSubscriptionDefinition 

pub struct WebSocketSubscriptionDefinition { /* private fields */ }

Handler definition for one WebSocket subscription.

Implementations

impl WebSocketSubscriptionDefinition

pub fn new<H, Fut, R>(handler: H) -> Self

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

pub fn new_with_connection<H, Fut, R>(handler: H) -> Self

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

pub fn new_with_server<H, Fut, R>(handler: H) -> Self

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

pub fn metadata(&self) -> &BTreeMap<String, Value>

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

pub fn with_metadata<V>(self, key: impl Into<String>, value: V) -> Result<Self>

where V: Serialize,

pub fn with_metadata_value(self, key: impl Into<String>, value: Value) -> Self

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_interceptor<I>(self, interceptor: I) -> Self

where I: WebSocketInterceptor,

pub fn with_filter<F>(self, filter: F) -> Self

where F: WebSocketExceptionFilter,

pub fn with_catch_filter<I, F>(self, kinds: I, filter: F) -> Self

where I: IntoIterator<Item = BootErrorKind>, F: WebSocketExceptionFilter,

pub fn with_validation(self) -> Self

pub fn with_validation_options(self, options: ValidationOptions) -> Self

pub fn without_validation(self) -> Self

pub fn with_payload_validation<T>(self) -> Self

where T: DeserializeOwned + Validate + 'static,

pub fn with_payload_validation_options<T>( self, options: ValidationOptions, ) -> Self

where T: DeserializeOwned + Serialize + Validate + ValidationSchema + 'static,

Trait Implementations

impl Clone for WebSocketSubscriptionDefinition

fn clone(&self) -> WebSocketSubscriptionDefinition

Returns a duplicate of the value.

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

Performs copy-assignment from source.