Struct WaitGroup 

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

WaitGroup with clonable worker handles.

Cancellation safety

This future is cancellation safe.

It is also safe to poll again after completion.

let (wg, handle) = WaitGroup::new();
let mut wg = core::pin::pin!(wg);

assert!(!wg.is_done());

handle.done();

wg.as_mut().await;
assert!(wg.is_done());

// It is safe to await again (re-poll)
wg.as_mut().await;
assert!(wg.is_done());

Implementations

impl WaitGroup

pub fn new() -> (Self, WorkerHandle)

Creates a new WaitGroup and a clonable WorkerHandle.

The WaitGroup is used to await the completion of tasks. The WorkerHandle is used to signal task completion.

Examples

use compact_waitgroup::WaitGroup;

let (wg, handle) = WaitGroup::new();
// ... distribute handle ...

pub fn is_done(&self) -> bool

Checks if the WaitGroup has completed.

This returns true if all WorkerHandles have been dropped.

Examples

use compact_waitgroup::WaitGroup;

let (wg, handle) = WaitGroup::new();
assert!(!wg.is_done());

drop(handle);
assert!(wg.is_done());

Trait Implementations

impl Debug for WaitGroup

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

Formats the value using the given formatter.

impl Future for WaitGroup

type Output = ()

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempts to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.