Struct web_socket::WebSocket

pub struct WebSocket<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.

Default: 16 MB

Implementations

impl<IO> WebSocket<IO>

pub fn client(stream: IO) -> Self

Create a new websocket client instance.

pub fn server(stream: IO) -> Self

Create a websocket server instance.

impl<W> WebSocket<W>where W: Unpin + AsyncWrite,

pub async fn send(&mut self, data: impl Into<Frame<'_>>) -> Result<()>

Send message to a endpoint.

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

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

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.

It is used to send ping frame.

Example

let writer = Vec::new();
let mut ws = WebSocket::client(writer);
ws.send_ping("Hello!").await;

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

A Pong frame sent in response to a Ping frame must have identical “Application data” as found in the message body of the Ping frame being replied to.

A Pong frame MAY be sent unsolicited. This serves as a unidirectional heartbeat. A response to an unsolicited Pong frame is not expected.

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

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

impl<R> WebSocket<R>where R: Unpin + AsyncRead,

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

reads Event from websocket stream.

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

reads Event from websocket stream.

Trait Implementations

impl<Stream: Debug> Debug for WebSocket<Stream>

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

Formats the value using the given formatter.

impl<IO> From<(IO, Role)> for WebSocket<IO>

fn from((stream, role): (IO, Role)) -> Self

Converts to this type from the input type.