Struct TapSubscription 

pub struct TapSubscription { /* private fields */ }

One subscriber’s handle. Dropping it unsubscribes.

Implementations

impl TapSubscription

pub fn filter(&self) -> &TapFilter

The filter this subscription was made with.

pub fn take_batches(&self) -> Result<Vec<TapBatch>, TapError>

Takes every held message as batches, one per run of messages admitted at the same divisor, oldest first, then halves the divisor (the subscriber has drained). The evictions since the previous take ride the first batch; with no messages and a nonzero eviction count, one empty batch carries it. With neither, nothing is returned.

Errors

Returns TapError::Poisoned when the subscriber state is poisoned.

pub fn sample_one_in(&self) -> Result<NonZeroU32, TapError>

The current sampling divisor.

Errors

Returns TapError::Poisoned when the subscriber state is poisoned.

pub fn held(&self) -> Result<usize, TapError>

Messages held right now (never above the capacity).

Errors

Returns TapError::Poisoned when the subscriber state is poisoned.

Trait Implementations

impl Debug for TapSubscription

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

Formats the value using the given formatter.

impl Drop for TapSubscription

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.