Struct SubscriptionHandle 

pub struct SubscriptionHandle {
    pub subscription_id: SubscriptionId,
    /* private fields */
}

Handle to a live subscription (RFC §13).

Dropping the handle removes the client-side forwarder and stops local delivery; it does not send an unsubscribe envelope. Call Self::unsubscribe to shut down gracefully with an explicit unsubscribe on the wire.

Fields

subscription_id: SubscriptionId

The subscription’s id.

Implementations

impl SubscriptionHandle

pub async fn next(&self) -> Option<Envelope>

Receive the next envelope, or None when the subscription is torn down.

pub async fn unsubscribe(self) -> Result<(), ARCPError>

Send an unsubscribe envelope and detach locally. The handle is also detached on Drop, but explicit unsubscribe is the polite shutdown.

Errors

Returns ARCPError::Unavailable if the transport is already closed.

Trait Implementations

impl Debug for SubscriptionHandle

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

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.