[][src]Struct wait_for_me::CountDownLatch

pub struct CountDownLatch { /* fields omitted */ }

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

Implementations

impl CountDownLatch[src]

pub fn new(count: usize) -> CountDownLatch[src]

Creates a new CountDownLatch with a given count.

pub async fn count<'_>(&'_ self) -> usize[src]

Returns the current count.

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

Cause the current task to wait until the counter reaches zero

pub async fn wait_for<'_>(&'_ self, timeout: Duration) -> bool[src]

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

If the specified timeout elapesed false is retured. Otherwise true.

pub async fn count_down<'_>(&'_ self)[src]

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

Trait Implementations

impl Clone for CountDownLatch[src]

Auto Trait Implementations

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.