Struct WebSocket 

pub struct WebSocket { /* private fields */ }

An established WebSocket connection.

See the module docs for an example.

Implementations

impl WebSocket

pub async fn recv(&mut self) -> Option<Result<Message, Error>>

Receive the next message. Returns None once the stream has closed.

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

Send a message.

Errors

Returns an error if the underlying connection has been closed or a protocol error occurs while writing.

pub async fn flush(&mut self) -> Result<(), Error>

Flush any buffered outgoing messages.

Errors

Returns an error if the underlying connection has been closed or a protocol error occurs while flushing.

pub async fn close(self) -> Result<(), Error>

Gracefully close the connection, consuming it.

Errors

Returns an error if a protocol error occurs while closing.

pub const fn protocol(&self) -> Option<&HeaderValue>

The selected WebSocket subprotocol, if one was negotiated.

pub fn split( self, ) -> (impl Sink<Message, Error = Error> + Send, impl Stream<Item = Result<Message, Error>> + Send)

Split into independent sink and stream halves, for concurrent read/write tasks.

Internally this hands the connection off to a background task (since the raw frame socket, like a plain TCP stream, isn’t safe to drive concurrently from two tasks at once) and bridges to it over a pair of bounded channels — bounded so a stalled peer or a consumer that stops polling the stream applies real backpressure instead of letting queued messages grow without limit.

Trait Implementations

impl Debug for WebSocket

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

Formats the value using the given formatter.