Struct web_socket::WebSocket

pub struct WebSocket<const SIDE: bool, Stream> {
    pub stream: Stream,
    pub max_payload_len: usize,
    /* private fields */
}

WebSocket implementation for both client and server

Fields

stream: Stream

it is a low-level abstraction that represents the underlying byte stream over which WebSocket messages are exchanged.

max_payload_len: usize

maximum allowed payload length in bytes

Implementations

impl<IO> WebSocket<CLIENT, IO>

pub fn client(stream: IO) -> Self

Create a new websocket client instance.

impl<IO> WebSocket<SERVER, IO>

pub fn server(stream: IO) -> Self

Create a websocket server instance.

impl<const SIDE: bool, W: Unpin + AsyncWrite> WebSocket<SIDE, W>

pub async fn send(&mut self, data: impl Message) -> Result<()>

Send message to a endpoint.

pub async fn send_ping(&mut self, data: impl AsRef<[u8]>) -> Result<()>

A Ping frame may serve either as a keepalive or as a means to verify that the remote endpoint is still responsive.

pub async fn send_pong(&mut self, data: impl AsRef<[u8]>) -> Result<()>

Sends a pong frame in response to a ping frame received from the WebSocket endpoint.

pub async fn flash(&mut self) -> Result<()>

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination.

pub async fn close<T>(self, reason: T) -> Result<()>where T: CloseFrame, T::Frame: AsRef<[u8]>,

• The Close frame MAY contain a body that indicates a reason for closing.

impl<const SIDE: bool, R> WebSocket<SIDE, R>where R: Unpin + AsyncRead,

pub async fn recv(&mut self) -> Result<Event>

reads Event from websocket stream.

Trait Implementations

impl<const SIDE: bool, Stream: Debug> Debug for WebSocket<SIDE, Stream>

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

Formats the value using the given formatter.

impl<const SIDE: bool, IO> From<IO> for WebSocket<SIDE, IO>

fn from(stream: IO) -> Self

Converts to this type from the input type.