Struct atomic_waitgroup::WaitGroup

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

Implementations

impl WaitGroup

pub fn new() -> Self

pub fn left(&self) -> usize

Return the count left inside this WaitGroup

pub fn add(&self, i: usize)

Add specified count.

NOTE

Although add() does not conflict with wait()/wait_to(), Be sure to avoid concurrency of add() & done() which might lead to ill logic.

pub fn add_guard(&self) -> WaitGroupGuard

Add one to the WaitGroup, return a guard to decrease the count on drop.

Example

extern crate atomic_waitgroup;
use atomic_waitgroup::WaitGroup;
use tokio::runtime::Runtime;

let wg = WaitGroup::new();
let rt = Runtime::new().unwrap();
rt.block_on(async move {
    let _guard = wg.add_guard();
    tokio::spawn(async move {
        // Do something
        drop(_guard);
    });
    wg.wait().await;
});

pub async fn wait_to(&self, target: usize) -> bool

Wait until specified count is left in the WaitGroup.

Return false means there’s no waiting happened.

Return true means the blocking actually happened.

NOTE

• Only assume one waiting future at the same time, otherwise will panic.

• Canceling future is supported.

pub async fn wait(&self)

Wait until zero count in the WaitGroup.

NOTE

• Only assume one waiting future at the same time, otherwise will panic.

• Canceling future is supported.

pub fn done(&self)

Decrease count by one.

NOTE

Be sure to avoid concurrency of add() & done() which might lead to ill logic.

pub fn done_many(&self, count: usize)

Decrease count by specified value

Trait Implementations

impl Clone for WaitGroup

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.