Struct Consumer 

pub struct Consumer<'a> { /* private fields */ }

The sole taking handle for a CountedSignal.

This handle is Send + !Sync and may atomically take counts while its paired producer increments from another context.

use ph_eventing::counted_signal::Consumer;

fn assert_sync<T: Sync>() {}
assert_sync::<Consumer<'static>>();

Implementations

impl Consumer<'_>

pub fn take_count(&self) -> CountSnapshot

Atomically take the count accumulated since the preceding take.

A concurrent increment belongs wholly to this snapshot or wholly to the next one. CountSnapshot::is_saturated distinguishes the saturation sentinel from an exact count.

Trait Implementations

impl Debug for Consumer<'_>

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

Formats the value using the given formatter.

impl Drop for Consumer<'_>

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.