Struct WebSocket 

pub struct WebSocket { /* private fields */ }

A WebSocket connection being monitored.

This struct represents an active WebSocket connection and provides methods to register handlers for frame events.

Implementations

impl WebSocket

pub fn url(&self) -> &str

Get the WebSocket URL.

pub fn is_closed(&self) -> bool

Check if the WebSocket is closed.

pub fn request_id(&self) -> &str

Get the request ID for this WebSocket.

pub async fn on_framesent<F, Fut>(&self, handler: F)

where F: Fn(WebSocketFrame) -> Fut + Send + Sync + 'static, Fut: Future<Output = ()> + Send + 'static,

Register a handler for frame sent events.

The handler will be called whenever a frame is sent over this WebSocket.

Example

use viewpoint_core::WebSocket;

websocket.on_framesent(|frame| async move {
    println!("Sent: {:?}", frame.payload());
}).await;

pub async fn on_framereceived<F, Fut>(&self, handler: F)

where F: Fn(WebSocketFrame) -> Fut + Send + Sync + 'static, Fut: Future<Output = ()> + Send + 'static,

Register a handler for frame received events.

The handler will be called whenever a frame is received on this WebSocket.

Example

use viewpoint_core::WebSocket;

websocket.on_framereceived(|frame| async move {
    println!("Received: {:?}", frame.payload());
}).await;

pub async fn on_close<F, Fut>(&self, handler: F)

where F: Fn() -> Fut + Send + Sync + 'static, Fut: Future<Output = ()> + Send + 'static,

Register a handler for WebSocket close events.

The handler will be called when this WebSocket connection is closed.

Example

use viewpoint_core::WebSocket;

websocket.on_close(|| async {
    println!("WebSocket closed");
}).await;

Trait Implementations

impl Clone for WebSocket

fn clone(&self) -> WebSocket

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.