Struct _WSI 

pub struct _WSI { /* private fields */ }

Platform-specific (WASM/browser) WebSocket interface backing the WebSocket client; owns the underlying socket, connection settings, channels and reconnection state.

Implementations

impl WebSocketInterface

pub fn new( url: Option<&str>, config: Option<WebSocketConfig>, sender_channel: Channel<(Message, Ack)>, receiver_channel: Channel<Message>, ) -> Result<WebSocketInterface>

Create a new interface for the optional default URL and configuration, wired to the given sender and receiver channels.

pub fn default_url(self: &Arc<Self>) -> Option<String>

Return the configured default URL used when no per-connect URL is given.

pub fn current_url(self: &Arc<Self>) -> Option<String>

Return the URL of the current (or most recent) connection.

pub fn set_default_url(self: &Arc<Self>, url: &str)

Set the default URL used for subsequent connection attempts.

pub fn set_current_url(self: &Arc<Self>, url: &str)

Record the URL of the connection currently being established.

pub fn is_connected(self: &Arc<Self>) -> bool

Return true if the socket is currently connected.

pub fn configure(&self, config: WebSocketConfig)

Replace the configuration applied to the next connection attempt.

pub async fn connect( self: &Arc<Self>, options: ConnectOptions, ) -> ConnectResult<Error>

Initiate the connection and start the background connect/reconnect task. Depending on options.block_async_connect, either blocks until connected or returns a receiver that fires once the connection is established.

pub fn try_send(self: &Arc<Self>, message: &Message) -> Result<()>

Attempt to send a message directly over the underlying socket without blocking, returning an error if the socket is not currently available.

pub async fn close(self: &Arc<Self>) -> Result<()>

Close the current connection, releasing its resources and emitting a Close event if it was connected; reconnection (if enabled) may follow.

pub async fn disconnect(self: &Arc<Self>) -> Result<()>

Disable reconnection and close the connection, fully disconnecting.

pub fn trigger_abort(self: &Arc<Self>) -> Result<()>

Force-close the underlying socket while connected to simulate a dropped connection; intended for testing reconnection logic.

Trait Implementations

impl Drop for WebSocketInterface

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.