Struct WebSocket 

pub struct WebSocket { /* private fields */ }

A WebSocket connection (server-side).

Notes:

• Server -> client frames are not masked.
• Client -> server frames must be masked (enforced).

Implementations

impl WebSocket

pub fn new(stream: TcpStream, buffered: Vec<u8>) -> Self

Create a websocket from a TCP stream and an optional prefix of already-buffered bytes.

pub async fn read_frame(&mut self) -> Result<Frame, WebSocketError>

Read the next frame.

pub async fn write_frame(&mut self, frame: &Frame) -> Result<(), WebSocketError>

Write a frame to the peer (server-side, unmasked).

pub async fn read_text(&mut self) -> Result<String, WebSocketError>

Convenience: read a text message.

pub async fn read_text_or_close( &mut self, ) -> Result<Option<String>, WebSocketError>

Convenience: read a text message, transparently handling ping/pong/close.

Behavior:

• Ping frames are answered with Pong (same payload) and ignored.
• Pong frames are ignored.
• Close frames are replied to with a Close echo and return Ok(None).
• Any non-text data frame returns a protocol error.

pub async fn send_pong(&mut self, payload: &[u8]) -> Result<(), WebSocketError>

Send a Pong control frame (server-side, unmasked).

pub async fn send_text(&mut self, text: &str) -> Result<(), WebSocketError>

Convenience: send a text message.

pub async fn send_bytes(&mut self, data: &[u8]) -> Result<(), WebSocketError>

Convenience: send a binary message.

pub async fn ping(&mut self, payload: &[u8]) -> Result<(), WebSocketError>

Convenience: send a Ping control frame.

pub async fn close( &mut self, close_code: u16, reason: Option<&str>, ) -> Result<(), WebSocketError>

Initiate a close handshake with an explicit close code and optional reason.

Trait Implementations

impl Debug for WebSocket

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

Formats the value using the given formatter.