Struct Subscription 

pub struct Subscription { /* private fields */ }

A live event subscription. Drop to unsubscribe.

Subscription is Send but not Clone. It can be moved to another thread but not shared.

Implementations

impl Subscription

pub fn new(rx: EventReceiver, cancel: CancelHandle) -> Subscription

Create a new subscription from its components.

pub fn try_recv(&self) -> Option<Event>

Try to receive without blocking (returns None if no event ready).

pub fn recv(&self, timeout: Duration) -> Result<Event, Error>

Block until an event arrives or the timeout expires.

pub fn recv_status(&self, timeout: Duration) -> RecvStatus

Block until an event arrives, the timeout expires, or the event source disconnects. Unlike recv, this preserves the distinction between “no event yet” and “no events will ever arrive” so bindings can terminate their poll loops cleanly when the subscription shuts down.

pub fn wait_for( &self, predicate: impl Fn(&Event) -> bool, timeout: Duration, ) -> Result<Event, Error>

Block until an event matching predicate arrives or the timeout expires.

If the event stream disconnects (all senders dropped) before a match arrives, wait_for short-circuits with Error::Timeout carrying the actual elapsed time — no further matching event can ever arrive, so burning the remainder of the timeout in a dead poll loop is pointless.

pub fn iter(&self) -> SubscriptionIter<'_>

Return a blocking iterator over incoming events.

The iterator yields events until the subscription is dropped or the event source disconnects (all senders dropped).