Struct WebSocketRelayEventOutput 

pub struct WebSocketRelayEventOutput {
    pub messages: Vec<WebSocketRelayMessage>,
    pub close: Option<WebSocketRelayClose>,
    pub extensions: Extensions,
}

Output for middleware used by WebSocketRelayEventService.

Fields

messages: Vec<WebSocketRelayMessage>

Zero or more data messages to send to the opposite WebSocket connection.

Ping, pong and raw frames cannot be produced through this API.

close: Option<WebSocketRelayClose>

Optionally request coordinated shutdown of both WebSocket connections. Messages are sent before a valid requested shutdown starts.

When serving WebSocketRelayEvent::Close, shutdown has already been initiated by the relay and both messages and close are ignored.

extensions: Extensions

Per-direction relay state. Middleware should normally return the input store (or a derivative of it); replacing it with a fresh store also replaces its connection-extension parent link.

Trait Implementations

impl Clone for WebSocketRelayEventOutput

fn clone(&self) -> WebSocketRelayEventOutput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WebSocketRelayEventOutput

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

Formats the value using the given formatter.

impl ExtensionsRef for WebSocketRelayEventOutput

fn extensions(&self) -> &Extensions

Get reference to the underlying Extensions store

impl From<WebSocketRelayEventInput> for WebSocketRelayEventOutput

fn from(value: WebSocketRelayEventInput) -> Self

Converts to this type from the input type.