Struct SubscriptionHandle 

pub struct SubscriptionHandle { /* private fields */ }

A handle to an active subscription that automatically unsubscribes when dropped.

SubscriptionHandle implements a RAII pattern for WebSocket subscriptions. When the handle is dropped, it decrements the reference count for the stream and triggers an UNSUBSCRIBE command if no more handles reference the stream.

Example

let handle = subscription_manager.subscribe("btcusdt@ticker", ...).await?;
// ... use the subscription ...
drop(handle); // Automatically unsubscribes when dropped

Implementations

impl SubscriptionHandle

pub fn new( stream: String, subscription_manager: Arc<SubscriptionManager>, message_router: Option<Arc<MessageRouter>>, ) -> Self

Creates a new subscription handle.

pub fn stream(&self) -> &str

Returns the stream name associated with this handle.

pub async fn release(self) -> Result<()>

Manually releases the subscription handle.

This is equivalent to dropping the handle, but allows for async cleanup. After calling this method, the Drop implementation will be a no-op.

Trait Implementations

impl Drop for SubscriptionHandle

fn drop(&mut self)

Executes the destructor for this type.