Struct dispatch::Group

pub struct Group { /* fields omitted */ }

A Grand Central Dispatch group.

A Group is a mechanism for grouping closures and monitoring them. This allows for aggregate synchronization, so you can track when all the closures complete, even if they are running on different queues.

Methods

impl Group

pub fn create() -> Group

Creates a new dispatch Group.

pub fn enter(&self) -> GroupGuard

Indicates that a closure has entered self, and increments the current count of outstanding tasks. Returns a GroupGuard that should be dropped when the closure leaves self, decrementing the count.

pub fn async<F>(&self, queue: &Queue, work: F) where
    F: 'static + Send + FnOnce(), 

Submits a closure asynchronously to the given Queue and associates it with self.

pub fn notify<F>(&self, queue: &Queue, work: F) where
    F: 'static + Send + FnOnce(), 

Schedules a closure to be submitted to the given Queue when all tasks associated with self have completed. If self is empty, the closure is submitted immediately.

pub fn wait(&self)

Waits synchronously for all tasks associated with self to complete.

pub fn wait_timeout_ms(&self, ms: u32) -> bool

Waits for all tasks associated with self to complete within the specified duration. Returns true if the tasks completed or false if the timeout elapsed.

pub fn wait_timeout(&self, timeout: Duration) -> bool

Waits for all tasks associated with self to complete within the specified duration. Returns true if the tasks completed or false if the timeout elapsed.

pub fn is_empty(&self) -> bool

Returns whether self is currently empty.

Trait Implementations

impl Sync for Group

impl Clone for Group

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Drop for Group

fn drop(&mut self)

Executes the destructor for this type.

impl Send for Group