Struct WebSocketClient 

pub struct WebSocketClient { /* private fields */ }

A WebSocket client for browser / WASM environments.

When the wasm-bindgen feature is active (the default) this struct can be exported to JavaScript via #[wasm_bindgen].

Implementations

impl WebSocketClient

pub fn new(url: String, config: WebSocketConfig) -> Self

Create a new client for url with the given WebSocketConfig.

The connection is not established until connect is called.

pub fn url(&self) -> &str

Returns the URL this client was created with.

pub fn is_connected(&self) -> bool

Returns true when the underlying socket is open and ready to send.

impl WebSocketClient

pub async fn connect(&mut self) -> Result<(), JsValue>

Available on crate feature wasm-bindgen only.

Open the WebSocket connection.

Registers onopen, onmessage, onerror, and onclose callbacks that log to the browser console. For production use, replace the closures with application-specific logic.

Errors

Returns a JsValue error if the browser rejects the URL or if the socket is already open.

pub fn send_text(&self, text: &str) -> Result<(), JsValue>

Available on crate feature wasm-bindgen only.

Send a UTF-8 text message.

Errors

Returns a JsValue error if the socket is not connected or if the browser’s send() call fails.

pub fn send_binary(&self, data: &[u8]) -> Result<(), JsValue>

Available on crate feature wasm-bindgen only.

Send a binary message.

The slice is copied into a JS Uint8Array and transferred over the wire as an ArrayBuffer frame.

Errors

Returns a JsValue error if the socket is not connected or if the browser’s send() call fails.

pub fn close(&mut self) -> Result<(), JsValue>

Available on crate feature wasm-bindgen only.

Close the WebSocket with the normal-closure code 1000.

Errors

Returns a JsValue error if the socket is not connected or if the browser’s close() call fails.

pub fn ready_state(&self) -> u16

Available on crate feature wasm-bindgen only.

Return the underlying WebSocket ready-state code.

Code	Meaning
0	CONNECTING
1	OPEN
2	CLOSING
3	CLOSED

Trait Implementations

impl Debug for WebSocketClient

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

Formats the value using the given formatter.