Struct scoped_pool::WaitGroup

pub struct WaitGroup { /* fields omitted */ }

A synchronization primitive for awaiting a set of actions.

Adding new jobs is done with submit, jobs are completed with complete, and any thread may wait for all jobs to be completed with join.

Methods

impl WaitGroup

pub fn new() -> Self

Create a new empty WaitGroup.

pub fn waiting(&self) -> usize

How many submitted tasks are waiting for completion.

pub fn submit(&self)

Submit to this WaitGroup, causing join to wait for an additional complete.

pub fn complete(&self)

Complete a previous submit.

pub fn poison(&self)

Poison the WaitGroup so all joining threads panic.

pub fn join(&self)

Wait for submits to this WaitGroup to be completed.

Submits occuring completely before joins will always be waited on.

Submits occuring concurrently with a join may or may not be waited for.

Before submitting, join will always return immediately.

Trait Implementations

impl Default for WaitGroup

fn default() -> Self

Returns the "default value" for a type.