Struct WebsocketStream

pub struct WebsocketStream<T> {
    pub id: Option<String>,
    /* private fields */
}

Fields

id: Option<String>

Implementations

impl<T> WebsocketStream<T>

where T: DeserializeOwned + Send + 'static,

pub fn on_message<F>(self: &Arc<Self>, callback_fn: F)

where T: Send + Sync, F: Fn(T) + Send + Sync + 'static,

Synchronously sets a message callback for the WebSocket stream on the current thread.

Arguments

• callback_fn - A function that will be called with the deserialized message payload

Panics

Panics if the thread runtime fails to be created or if the thread join fails

Examples

let stream = Arc::new(WebsocketStream::new()); stream.on_message(|data: MyType| { // Handle the deserialized message });

pub async fn unsubscribe(&self)

Unsubscribes from the current WebSocket stream and removes the associated callback.

This method performs the following actions:

• Removes the current callback associated with the stream
• Removes the callback from the connection’s stream callbacks
• Asynchronously unsubscribes from the stream using the WebSocket streams base

Panics

Panics if the stream is not subscribed to

Notes

• If no callback is present, no action is taken
• Spawns an asynchronous task to handle the unsubscription process