Struct WaitGroup 

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

WaitGroup with clonable group tokens.

Cancellation safety

This future is cancellation safe.

It is also safe to poll again after completion.

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

assert!(!wg.is_done());

token.release();

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, GroupTokenFactory)

Creates a new WaitGroup and a GroupTokenFactory.

pub fn is_done(&self) -> bool

Checks if the WaitGroup has completed.

This returns true if all GroupTokens have been dropped.

Trait Implementations

impl Debug for WaitGroup

fn fmt(&self, __derive_more_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.