Struct ThreadCounter

pub struct ThreadCounter { /* private fields */ }

A thread-safe counter for tracking the number of active threads or operations.

This struct provides a high-level interface for incrementing, decrementing, and waiting on a thread counter. It internally uses Arc to allow for cheap cloning and shared ownership.

Implementations

impl ThreadCounter

pub fn ticket(&self) -> Ticket

Creates a new Ticket from this thread counter.

This method increments the thread count and returns a Ticket that will automatically decrement the count when dropped.

Returns

A new Ticket instance associated with this counter.

Methods from Deref<Target = RawThreadCounter>

pub fn increment(&self)

Increments the thread counter.

Note

It’s preferable to use ThreadCounter::ticket() instead, which ensures that the count is automatically decremented when the ticket is dropped.

pub fn decrement(&self)

Decrements the thread counter.

If the count reaches zero, it notifies all waiting threads.

Note

It’s preferable to use ThreadCounter::ticket() instead, which ensures that the count is automatically decremented when the ticket is dropped.

pub fn wait(&self, timeout: impl Into<Option<Duration>>) -> bool

Waits for the counter to reach zero, with an optional timeout.

Arguments

• timeout - An optional duration to wait. If None, waits indefinitely.

Returns

• true if the count reached zero.
• false if the timeout was reached before the count reached zero.

Trait Implementations

impl AsRef<RawThreadCounter> for ThreadCounter

fn as_ref(&self) -> &RawThreadCounter

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for ThreadCounter

fn clone(&self) -> ThreadCounter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for ThreadCounter

fn default() -> ThreadCounter

Returns the “default value” for a type.

impl Deref for ThreadCounter

type Target = RawThreadCounter

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.