Struct CountDownLatch

pub struct CountDownLatch { /* private fields */ }

A synchronization aid that allows one or more tasks to wait until a set of operations being performed in other tasks completes.

Implementations

impl CountDownLatch

pub fn new(count: u32) -> Self

Creates a new CountDownLatch initialized with the given count.

Arguments

• count - The number of times count_down must be invoked before tasks can pass through wait.

Returns

A new CountDownLatch.

pub async fn count_down(&self)

Decrements the count of the latch, releasing all waiting tasks if the count reaches zero.

This method is asynchronous and will lock the internal count before decrementing it.

pub async fn wait(&self)

Waits until the count reaches zero.

This method is asynchronous and will block the current task until the count reaches zero.

pub async fn wait_timeout(&self, timeout: Duration) -> bool

Waits until the count reaches zero or the specified timeout elapses.

This method is asynchronous and will block the current task until the count reaches zero or the timeout elapses.

Arguments

• timeout - The maximum duration to wait for the count to reach zero.

Returns

true if the count reached zero before the timeout elapsed, false otherwise.

Trait Implementations

impl Clone for CountDownLatch

fn clone(&self) -> CountDownLatch

Returns a copy of the value.

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

Performs copy-assignment from source.