Struct WebSocketWrite 

pub struct WebSocketWrite<IO> { /* private fields */ }

The write half of a split WebSocket.

This half can send messages but cannot receive. Use the read half’s reunite() to recombine.

Implementations

impl<IO> WebSocketWrite<IO>

where IO: AsyncRead + AsyncWrite + Unpin,

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

Send a message.

Cancel-Safety

If cancelled, the message may be partially sent. The connection should be closed if cancellation occurs mid-send.

pub async fn close(&mut self, reason: CloseReason) -> Result<(), WsError>

Initiate a close handshake.

Sends a close frame. The read half will receive the peer’s response.

pub async fn ping(&mut self, payload: impl Into<Bytes>) -> Result<(), WsError>

Send a ping frame.

pub fn is_open(&self) -> bool

Check if the connection is open.

pub fn is_closed(&self) -> bool

Check if the close handshake is complete.

pub fn close_state(&self) -> CloseState

Get the close state.