Struct JsonHandler 

pub struct JsonHandler<T> { /* private fields */ }

A wrapper type for JsonWebSocketHandlers

You do not need to interact with this type directly. Instead, use WebSocket::new_json or json_websocket.

Trait Implementations

impl<T> Debug for JsonHandler<T>

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

Formats the value using the given formatter.

impl<T> Deref for JsonHandler<T>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T> DerefMut for JsonHandler<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T> WebSocketHandler for JsonHandler<T>

where T: JsonWebSocketHandler,

type OutboundStream = SerializedStream<<T as JsonWebSocketHandler>::StreamType>

A Stream type that represents Messages to be sent to this client. It is built in your implementation code, in WebSocketHandler::connect. Use Pending<Message> or another stream that never returns if you do not need to use this aspect of the trait.

async fn connect( &self, conn: WebSocketConn, ) -> Option<(WebSocketConn, Self::OutboundStream)>

This interface is the only mandatory function in WebSocketHandler. It receives an owned WebSocketConn and optionally returns it along with an OutboundStream type.

async fn inbound(&self, message: Message, conn: &mut WebSocketConn)

This interface function is called once with every message received from a connected websocket client.

async fn disconnect( &self, conn: &mut WebSocketConn, close_frame: Option<CloseFrame>, )

This interface function is called with the websocket conn and, in the case of a clean disconnect, the CloseFrame if one is sent available.

fn send( &self, message: Message, conn: &mut WebSocketConn, ) -> impl Future<Output = Result<(), Error>> + Send

This interface function is called once with every outbound message in the OutboundStream. You likely do not need to implement this, but if you do, you must call conn.send(message).await or the message will not be sent.