Struct WebSocket 

pub struct WebSocket { /* private fields */ }

Represents a WebSocket client connection.

This struct manages the WebSocket lifecycle including:

• Connection state
• Message sending/receiving
• Configuration

Implementations

impl WebSocket

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

Sends a text message synchronously.

Arguments

• &str - The text message to send.

Returns

• WebSocketResult - Result indicating success or failure.

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

Sends a binary message synchronously.

Arguments

• &[u8] - The binary data to send.

Returns

• WebSocketResult - Result indicating success or failure.

pub fn send_ping(&mut self, data: &[u8]) -> WebSocketResult

Sends a ping message synchronously.

Arguments

• &[u8] - The ping data to send.

Returns

• WebSocketResult - Result indicating success or failure.

pub fn send_pong(&mut self, data: &[u8]) -> WebSocketResult

Sends a pong message synchronously.

Arguments

• &[u8] - The pong data to send.

Returns

• WebSocketResult - Result indicating success or failure.

pub fn receive(&mut self) -> WebSocketMessageResult

Receives a message synchronously.

Returns

• WebSocketMessageResult - Result containing the received message or error.

pub fn close(&mut self) -> WebSocketResult

Closes the WebSocket connection synchronously.

Returns

• WebSocketResult - Result indicating success or failure.

pub fn is_connected(&self) -> bool

Checks if the WebSocket is currently connected.

Returns

• bool - True if connected, false otherwise.

pub async fn send_text_async(&mut self, text: &str) -> WebSocketResult

Sends a text message asynchronously.

Arguments

• &str - The text message to send.

Returns

• WebSocketResult - Result indicating success or failure.

pub async fn send_binary_async(&mut self, data: &[u8]) -> WebSocketResult

Sends a binary message asynchronously.

Arguments

• &[u8] - The binary data to send.

Returns

• WebSocketResult - Result indicating success or failure.

pub async fn send_ping_async(&mut self, data: &[u8]) -> WebSocketResult

Sends a ping message asynchronously.

Arguments

• &[u8] - The ping data to send.

Returns

• WebSocketResult - Result indicating success or failure.

pub async fn send_pong_async(&mut self, data: &[u8]) -> WebSocketResult

Sends a pong message asynchronously.

Arguments

• &[u8] - The pong data to send.

Returns

• WebSocketResult - Result indicating success or failure.

pub async fn receive_async(&mut self) -> WebSocketMessageResult

Receives a message asynchronously.

Returns

• WebSocketMessageResult - Result containing the received message or error.

pub async fn close_async_method(&mut self) -> WebSocketResult

Closes the WebSocket connection asynchronously.

Returns

• WebSocketResult - Result indicating success or failure.

Trait Implementations

impl AsyncWebSocketTrait for WebSocket

Asynchronous WebSocket trait implementation.

Provides asynchronous methods for WebSocket operations including:

• Sending messages (text, binary, ping, pong)
• Receiving messages
• Closing connections
• Checking connection status

fn send_text<'a>( &'a mut self, text: &'a str, ) -> Pin<Box<dyn Future<Output = WebSocketResult> + Send + 'a>>

Sends a text message asynchronously.

fn send_binary<'a>( &'a mut self, data: &'a [u8], ) -> Pin<Box<dyn Future<Output = WebSocketResult> + Send + 'a>>

Sends a binary message asynchronously.

fn send_ping<'a>( &'a mut self, data: &'a [u8], ) -> Pin<Box<dyn Future<Output = WebSocketResult> + Send + 'a>>

Sends a ping message asynchronously.

fn send_pong<'a>( &'a mut self, data: &'a [u8], ) -> Pin<Box<dyn Future<Output = WebSocketResult> + Send + 'a>>

Sends a pong message asynchronously.

fn receive( &mut self, ) -> Pin<Box<dyn Future<Output = WebSocketMessageResult> + Send + '_>>

Receives a message asynchronously.

fn close( &mut self, ) -> Pin<Box<dyn Future<Output = WebSocketResult> + Send + '_>>

Closes the WebSocket connection asynchronously.

fn is_connected(&self) -> bool

Checks if the WebSocket is currently connected.

impl Clone for WebSocket

Clone implementation for WebSocket.

Creates a new WebSocket instance with cloned configuration but resets:

• Connection status to false
• Connection to None

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WebSocket

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

Formats the value using the given formatter.

impl Default for WebSocket

Default implementation for WebSocket.

Creates a WebSocket with:

• Empty URL
• Empty headers
• Default configuration
• Disconnected state
• No active connection

fn default() -> Self

Returns the “default value” for a type.

impl WebSocketTrait for WebSocket

Synchronous WebSocket trait implementation.

Provides synchronous methods for WebSocket operations including:

• Sending messages (text, binary, ping, pong)
• Receiving messages
• Closing connections
• Checking connection status

fn send_text(&mut self, text: &str) -> WebSocketResult

Sends a text message synchronously.

fn send_binary(&mut self, data: &[u8]) -> WebSocketResult

Sends a binary message synchronously.

fn send_ping(&mut self, data: &[u8]) -> WebSocketResult

Sends a ping message synchronously.

fn send_pong(&mut self, data: &[u8]) -> WebSocketResult

Sends a pong message synchronously.

fn receive(&mut self) -> WebSocketMessageResult

Receives a message synchronously.

fn close(&mut self) -> WebSocketResult

Closes the WebSocket connection synchronously.

fn is_connected(&self) -> bool

Checks if the WebSocket is currently connected.