Struct WaitGroup

pub struct WaitGroup { /* private fields */ }

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

Implementations

impl WaitGroup

pub fn new() -> WaitGroup

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

Examples

use async_wg::WaitGroup;
let wg = WaitGroup::new();

pub async fn add(&self, delta: isize)

Add count n.

Panic

1. The argument delta must be a positive number (> 0).
2. The max count must be less than isize::max_value() / 2.

pub async fn done(&self)

Done count 1.

pub async fn count(&self) -> isize

Get the inner count of WaitGroup, the primary count is 0.

Trait Implementations

impl Clone for WaitGroup

fn clone(&self) -> WaitGroup

Returns a copy of the value.

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

Performs copy-assignment from source.

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.