Struct Websocket 

pub struct Websocket<In = String, Out = String, E = JsonEncoding> { /* private fields */ }

A WebSocket connection that can send and receive messages of type In and Out.

Implementations

impl<I, O, E> Websocket<I, O, E>

pub async fn recv(&self) -> Result<O, WebsocketError>

where O: DeserializeOwned, E: Encoding,

pub async fn send(&self, msg: I) -> Result<(), WebsocketError>

where I: Serialize, E: Encoding,

Send a typed message over the WebSocket connection.

This method serializes the message using the specified encoding E before sending it. The message will always be sent as a binary message, even if the encoding is valid UTF-8 like JSON.

pub async fn send_raw(&self, message: Message) -> Result<(), WebsocketError>

Send a raw message over the WebSocket connection.

This method allows sending text, binary, ping, pong, and close messages directly.

pub async fn recv_raw(&self) -> Result<Message, WebsocketError>

Receive a raw message from the WebSocket connection.

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

Trait Implementations

impl<In, Out, E> IntoResponse for Websocket<In, Out, E>

fn into_response(self) -> Response

Create a response.

impl<I, O, E> PartialEq for Websocket<I, O, E>

fn eq(&self, _other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.