WebSocketTrait

hyperlane_utils

Trait WebSocketTrait 

Source 
pub trait WebSocketTrait: Send + Sync {
    // Required methods
    fn send_text(&mut self, text: &str) -> Result<(), WebSocketError>;
    fn send_binary(&mut self, data: &[u8]) -> Result<(), WebSocketError>;
    fn send_ping(&mut self, data: &[u8]) -> Result<(), WebSocketError>;
    fn send_pong(&mut self, data: &[u8]) -> Result<(), WebSocketError>;
    fn receive(&mut self) -> Result<WebSocketMessage, WebSocketError>;
    fn close(&mut self) -> Result<(), WebSocketError>;
    fn is_connected(&self) -> bool;
}
Expand description

Synchronous WebSocket operations trait.

Defines the interface for synchronous WebSocket operations including:

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

Required Methods§

Source

fn send_text(&mut self, text: &str) -> Result<(), WebSocketError>

Sends a text message synchronously.

§Arguments
  • &str - The text message to send.
§Returns
  • WebSocketResult - Result indicating success or failure.
Source

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

Sends a binary message synchronously.

§Arguments
  • &[u8] - The binary data to send.
§Returns
  • WebSocketResult - Result indicating success or failure.
Source

fn send_ping(&mut self, data: &[u8]) -> Result<(), WebSocketError>

Sends a ping message synchronously.

§Arguments
  • &[u8] - The ping data to send.
§Returns
  • WebSocketResult - Result indicating success or failure.
Source

fn send_pong(&mut self, data: &[u8]) -> Result<(), WebSocketError>

Sends a pong message synchronously.

§Arguments
  • &[u8] - The pong data to send.
§Returns
  • WebSocketResult - Result indicating success or failure.
Source

fn receive(&mut self) -> Result<WebSocketMessage, WebSocketError>

Receives a message synchronously.

§Returns
  • WebSocketMessageResult - Result containing the received message or error.
Source

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

Closes the WebSocket connection synchronously.

§Returns
  • WebSocketResult - Result indicating success or failure.
Source

fn is_connected(&self) -> bool

Checks if the WebSocket is currently connected.

§Returns
  • bool - True if connected, false otherwise.

Implementors§