Struct WsReader 

pub struct WsReader { /* private fields */ }

The read half of a WebSocket (from split). Owns the receive path; can block in recv on its own thread while a WsWriter sends. Incoming pings are still auto-ponged (via the shared, write-serialized transport) and a peer close is echoed.

Implementations

impl WsReader

pub fn set_auto_pong(&mut self, on: bool)

Enable/disable automatic PONG replies to pings (curl’s CURLWS_NOAUTOPONG). Affects recv_event only; recv always auto-pongs.

pub fn set_read_timeout(&self, dur: Option<Duration>) -> Result<()>

Set the per-read inactivity timeout. None blocks indefinitely.

pub fn shutdown_handle(&self) -> Option<WsShutdown>

A handle to force-close the socket from another thread, unblocking this reader if it’s parked in recv. See WsShutdown.

pub fn is_closed(&self) -> bool

Whether the connection is closed or closing (either half).

pub fn recv(&mut self) -> Result<Option<WsMessage>>

Block until the next data message arrives, auto-answering interleaved control frames. Ok(None) once the peer closes.

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

Receive the next WsEvent, surfacing control frames. A ping is auto-ponged (through the shared, write-serialized transport) unless auto-pong is off; a close is echoed.

pub fn recv_frame(&mut self) -> Result<WsFrame>

Receive a single raw frame (no reassembly/decompression/control handling) — curl’s raw mode.