Struct Subscription 

pub struct Subscription<S> { /* private fields */ }

A live server-push subscription stream. Drain events with Self::next; call Self::unsubscribe for a clean teardown (the server then EOS-closes the event stream, which next observes as end-of-stream).

Dropping a subscription deregisters its route so a forgotten handle doesn’t leak an entry in the route table — but Drop can’t send UNSUBSCRIBE (it isn’t async), so a dropped-without-unsubscribe subscription leaves the server pushing into a now-dead channel until it notices. Prefer unsubscribe().await before dropping.

Implementations

impl<S> Subscription<S>

where S: AsyncWrite,

pub fn stream_id(&self) -> u32

The stream id the server pushes events on. Pass it to the server’s UNSUBSCRIBE target if driving the protocol manually.

pub async fn next(&mut self) -> Option<Result<SubscriptionEvent>>

Await the next subscription event. Returns Some(Ok(event)) for each pushed SUBSCRIBE_EVENT, Some(Err(_)) if a frame failed to decode or the server sent an ERROR on the stream, and None once the stream has ended (the server EOS-closed it, or the connection dropped).

An EOS-flagged frame carrying an event yields that event; the following call returns None. An EOS frame with an empty payload ends the stream immediately.

pub async fn unsubscribe(&self) -> Result<UnsubscribeResponse>

Tear the subscription down cleanly: send UNSUBSCRIBE on a fresh stream and await its UNSUBSCRIBE_RESP. The server then EOS-closes the event stream, which a subsequent Self::next observes as None.

Trait Implementations

impl<S> Debug for Subscription<S>

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

Hand-written so it does not require S: Debug.

impl<S> Drop for Subscription<S>

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.