Struct WaitGroup

pub struct WaitGroup { /* private fields */ }

Enables tasks to synchronize the beginning or end of some computation.

Examples

use async_waitgroup::WaitGroup;

// Create a new wait group.
let wg = WaitGroup::new();

for _ in 0..4 {
    // Create another reference to the wait group.
    let wg = wg.clone();

    tokio::spawn(async move {
        // Do some work.

        // Drop the reference to the wait group.
        drop(wg);
    });
}

// Block until all tasks have finished their work.
wg.wait().await;

Implementations

impl WaitGroup

pub fn new() -> Self

Creates a new wait group and returns the single reference to it.

Examples

use async_waitgroup::WaitGroup;

let wg = WaitGroup::new();

pub fn wait(self) -> Wait

Drops this reference and waits until all other references are dropped.

Examples

use async_waitgroup::WaitGroup;

let wg = WaitGroup::new();

tokio::spawn({
    let wg = wg.clone();
    async move {
        // Block until both tasks have reached `wait()`.
        wg.wait().await;
    }
});

// Block until all tasks have finished their work.
wg.wait().await;

pub fn wait_blocking(self)

Waits using the blocking strategy.

Examples

use std::thread;

use async_waitgroup::WaitGroup;

let wg = WaitGroup::new();

thread::spawn({
    let wg = wg.clone();
    move || {
        wg.wait_blocking();
    }
});

wg.wait_blocking();

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.

impl Debug for WaitGroup

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for WaitGroup

fn default() -> Self

Returns the “default value” for a type.

impl Drop for WaitGroup

fn drop(&mut self)

Executes the destructor for this type.