Struct EventSubscription 

pub struct EventSubscription { /* private fields */ }

Handle for receiving managed client events.

Each subscription has its own bounded queue configured by SubscriberConfig. The configured SubscriberOverflow policy applies when that queue is full. Dropping the handle unregisters the subscriber.

Implementations

impl EventSubscription

pub fn recv(&self) -> Result<ClientEvent, EventSubscriptionError>

Block until the next queued event is available.

If the subscription is disconnected, this returns EventSubscriptionError::Disconnected after any already queued events have been drained.

pub fn try_recv(&self) -> Result<Option<ClientEvent>, EventSubscriptionError>

Try to receive one queued event without blocking.

Returns Ok(None) when the subscription is still connected but no event is queued. If the subscription is disconnected, this returns EventSubscriptionError::Disconnected after any already queued events have been drained.

Trait Implementations

impl Debug for EventSubscription

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

Formats the value using the given formatter.

impl Drop for EventSubscription

fn drop(&mut self)

Executes the destructor for this type.