Struct WebSocketClient 

pub struct WebSocketClient { /* private fields */ }

WebSocket client for connecting to WebSocket servers.

Implementations

impl WebSocketClient

pub fn builder() -> WebSocketClientBuilder

Create a new client builder.

pub async fn connect(url: &str) -> WebSocketResult<Self>

Connect to a WebSocket server.

pub async fn connect_with_timeout( url: &str, timeout: Duration, ) -> WebSocketResult<Self>

Connect to a WebSocket server with a timeout.

pub fn send(&self, message: Message) -> WebSocketResult<()>

Send a message to the server.

pub fn send_text<S: Into<String>>(&self, text: S) -> WebSocketResult<()>

Send a text message.

pub fn send_binary<B: Into<Bytes>>(&self, data: B) -> WebSocketResult<()>

Send a binary message.

pub fn send_json<T: Serialize>(&self, value: &T) -> WebSocketResult<()>

Send a JSON message.

pub async fn recv(&mut self) -> Option<Message>

Receive the next message from the server.

pub fn try_recv(&mut self) -> Option<Message>

Try to receive a message without blocking.

pub fn close(&self)

Close the connection.

This method uses atomic compare-and-exchange to ensure only one task sends the close message, even when called concurrently.

pub fn is_closed(&self) -> bool

Check if the connection is closed.

Trait Implementations

impl Drop for WebSocketClient

fn drop(&mut self)

Executes the destructor for this type.