Struct Subscription 

pub struct Subscription { /* private fields */ }

A live subscription to a provider event stream.

The event receiver yields each StreamData payload for the held-open request’s correlation id. Await Subscription::closed to learn whether the provider ended the stream cleanly (StreamEnd) or the stream was rejected by an Error frame, route GOODBYE, connection drop, or local backpressure. Dropping the subscription sends a best-effort Cancel frame, the same as calling Subscription::unsubscribe.

Implementations

impl Subscription

pub fn events(&mut self) -> &mut Receiver<Vec<u8>>

Receive event payloads emitted as StreamData frames for this subscription.

pub fn closed(&mut self) -> &mut SubscriptionClosed

Future that resolves when the subscription reaches a terminal state.

It resolves with Ok(()) on StreamEnd or local unsubscribe, and returns a CallError for module Error frames, route teardown, connection loss, or event-channel backpressure. Await it after the event receiver returns None to distinguish a clean end from an error.

pub fn unsubscribe(&self) -> Result<(), CallError>

Cancel the held-open request.

This sends a best-effort header-only Cancel frame for the subscription’s (channel, corr) and settles Subscription::closed promptly with Ok(()). The provider may still send a terminal frame later; it is ignored because the local subscription is already closed.

Trait Implementations

impl Drop for Subscription

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.