Struct CountDownLatch

pub struct CountDownLatch { /* private fields */ }

A synchronization primitive that allows one or more tasks to wait until the given counter reaches zero. This is an async port of CountDownLatch in Java.

Implementations

impl CountDownLatch

pub fn new(count: usize) -> CountDownLatch

Creates a new CountDownLatch with a given count.

pub async fn count(&self) -> usize

Returns the current count.

pub fn wait(&self) -> impl Future<Output = ()>

Cause the current task to wait until the counter reaches zero

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

Cause the current task to wait until the counter reaches zero with timeout.

If the specified timeout elapsed false is returned. Otherwise true.

pub async fn count_down(&self)

Decrement the counter of one unit. If the counter reaches zero all the waiting tasks are released.

pub async fn set(&self, count: usize)

Sets the internal count.

Trait Implementations

impl Clone for CountDownLatch

fn clone(&self) -> CountDownLatch

Returns a duplicate of the value.

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

Performs copy-assignment from source.