Struct TestWebSocket 

pub struct TestWebSocket { /* private fields */ }

Available on non-WebAssembly only.

The test side of an upgraded connection; see the module docs.

Dropping it ends the connection (the handler’s recv returns an error), without waiting for the handler.

Implementations

impl TestWebSocket

pub fn handshake(&self) -> &TestResponse

The 101 response, for its headers (Sec-WebSocket-Protocol, …).

pub fn send_text(&mut self, text: &str)

Send a text message. Panics if the handler’s side is gone.

pub fn send_binary(&mut self, data: &[u8])

Send a binary message. Panics if the handler’s side is gone.

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

Send a ping; the handler’s pong is returned by recv_frame (and skipped by recv).

pub fn send(&mut self, frame: Frame) -> Result<(), String>

Send frame, masked as a client must.

pub fn send_raw(&mut self, bytes: &[u8]) -> Result<(), String>

Send bytes as they are — for testing how the handler copes with frames a well-behaved client wouldn’t send (unmasked, bad opcodes).

pub fn recv_frame(&mut self) -> Result<Frame, String>

The next frame from the handler, waiting at most the timeout. Pings are answered (and returned); nothing is joined.

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

The next message from the handler: Ok(None) once it sent a close frame (answered here, see close_code), Err on a timeout or when the handler returned without closing. Pings and pongs are skipped, fragments joined.

pub fn recv_text(&mut self) -> String

The next message, which must be text. Panics otherwise (binary, a close, a timeout), with what came instead.

pub fn recv_binary(&mut self) -> Vec<u8>

The next message, which must be binary. Panics otherwise.

pub fn close_code(&self) -> Option<Option<u16>>

The close code the handler sent, once it closed (Some(None) for a close frame without one).

pub fn close(self, code: u16, reason: &str) -> Option<u16>

Run the closing handshake: send a close frame with code and reason, skip messages until the handler’s close (or the timeout), then end the connection and wait (at most the timeout) for the handler to return. Returns the handler’s close code, None when it didn’t send one.

pub fn handler_finished(&self, timeout: Duration) -> bool

Wait at most timeout for the handler to return; true if it did.