Struct Counter

pub struct Counter(/* private fields */);

Simple counter with ability to notify task on reaching specific number

Counter could be cloned, total count is shared across all clones.

Implementations

impl Counter

pub fn new(capacity: usize) -> Self

Create Counter instance and set max value.

pub fn get(&self) -> CounterGuard

Get counter guard.

pub fn set_capacity(&self, cap: usize)

Set counter capacity

pub fn is_available(&self) -> bool

Check is counter has free capacity.

pub async fn available(&self)

Check if counter is not at capacity. If counter at capacity it registers notification for current task.

pub async fn unavailable(&self)

Wait untile counter becomes at capacity.

pub fn total(&self) -> usize

Get total number of acquired counts

Trait Implementations

impl Clone for Counter

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Counter

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

Formats the value using the given formatter.

impl Drop for Counter

fn drop(&mut self)

Executes the destructor for this type.