Struct SubscriptionHandle 

pub struct SubscriptionHandle { /* private fields */ }

An active subscriptions/listen request.

The handle exposes the JSON-RPC request ID used as the subscription ID, the server’s acknowledged filter, graceful server completion, and explicit cancellation. Dropping an active handle requests cancellation on a best-effort basis; callers that need confirmation should call cancel().

Implementations

impl SubscriptionHandle

pub fn id(&self) -> &RequestId

The JSON-RPC request ID that identifies this subscription.

pub async fn acknowledged(&mut self) -> Result<SubscriptionFilter>

Wait for the server’s mandatory first-message acknowledgment.

The returned filter is the subset the server agreed to honor.

pub async fn wait(self) -> Result<SubscriptionsListenResult>

Wait for the server to end the subscription gracefully.

An HTTP disconnect without a terminal response is reported as a transport error. Dropping this future drops the handle and cancels the subscription.

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

Cancel the subscription and wait until its transport stream is closed.

Trait Implementations

impl Drop for SubscriptionHandle

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.