Struct JobGroup 

pub struct JobGroup { /* private fields */ }

Thread-safe counter-based completion primitive for grouped jobs.

A JobGroup starts with zero pending jobs. Call add() before submitting work, then call done() once per completed job. wait() blocks until the pending count reaches zero.

Typical usage pattern: 1. add(N) 2. submit N tasks 3. each task calls done() on completion 4. wait() to join the group

Implementations

impl JobGroup

pub fn new() -> Self

Panics

Panics if the native allocation fails.

pub fn add(&mut self, n: usize)

Increment the number of pending jobs.

@param n Number of jobs to add to the group.

pub fn done(&mut self)

Mark one pending job as completed.

When the pending count reaches zero, all waiters are notified.

@note done() calls must be balanced with prior add() calls.

pub fn await_(&mut self)

Java’s Object.wait() is final so the generated wrapper would fail to compile; expose as await(). Block until all pending jobs in the group are completed.

pub fn is_ready(&self) -> bool

Check whether the group has no pending jobs.

@return true if pending count is zero, false otherwise.

Trait Implementations

impl Debug for JobGroup

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

Formats the value using the given formatter.

impl Default for JobGroup

fn default() -> Self

Returns the “default value” for a type.

impl Drop for JobGroup

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Send for JobGroup