Struct DispatchGroup 

#[repr(C)]
pub struct DispatchGroup { /* private fields */ }

Dispatch group.

Implementations

impl DispatchGroup

pub fn new() -> DispatchRetained<DispatchGroup>

Creates new group with which blocks may be associated.

This function creates a new group with which blocks may be associated. The dispatch group may be used to wait for the completion of the blocks it references. The group object memory is freed with dispatch_release().

Returns: The newly created group, or NULL on failure.

pub unsafe fn exec_async_with_block( self: &DispatchGroup, queue: &DispatchQueue, block: dispatch_block_t, )

pub unsafe fn exec_async_f( self: &DispatchGroup, queue: &DispatchQueue, context: *mut c_void, work: dispatch_function_t, )

Submits a function to a dispatch queue and associates the block with the given dispatch group.

See dispatch_group_async() for details.

Parameter group: A dispatch group to associate with the submitted function. The result of passing NULL in this parameter is undefined.

Parameter queue: The dispatch queue to which the function will be submitted for asynchronous invocation.

Parameter context: The application-defined context parameter to pass to the function.

Parameter work: The application-defined function to invoke on the target queue. The first parameter passed to this function is the context provided to dispatch_group_async_f().

impl DispatchGroup

pub unsafe fn notify_with_block( self: &DispatchGroup, queue: &DispatchQueue, block: dispatch_block_t, )

pub unsafe fn notify_f( self: &DispatchGroup, queue: &DispatchQueue, context: *mut c_void, work: dispatch_function_t, )

Schedule a function to be submitted to a queue when all the blocks associated with a group have completed.

See dispatch_group_notify() for details.

Parameter group: The dispatch group to observe. The result of passing NULL in this parameter is undefined.

Parameter context: The application-defined context parameter to pass to the function.

Parameter work: The application-defined function to invoke on the target queue. The first parameter passed to this function is the context provided to dispatch_group_notify_f().

impl DispatchGroup

pub unsafe fn leave(self: &DispatchGroup)

Manually indicate a block in the group has completed

Calling this function indicates block has completed and left the dispatch group by a means other than dispatch_group_async().

Parameter group: The dispatch group to update. The result of passing NULL in this parameter is undefined.

impl DispatchGroup

pub fn exec_async<F>(&self, queue: &DispatchQueue, work: F)

where F: Send + FnOnce() + 'static,

Submit a function to a DispatchQueue and associates it with the DispatchGroup.

pub fn wait(&self, timeout: DispatchTime) -> Result<(), WaitError>

Wait synchronously for the previously submitted functions to finish.

Errors

Return WaitError::Timeout in case of timeout.

pub fn notify<F>(&self, queue: &DispatchQueue, work: F)

where F: Send + FnOnce(),

Schedule a function to be submitted to a DispatchQueue when a group of previously submitted functions have completed.

pub fn enter(&self) -> DispatchGroupGuard

Explicitly indicates that the function has entered the DispatchGroup.

Trait Implementations

impl AsRef<AnyObject> for DispatchGroup

fn as_ref(&self) -> &AnyObject

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<DispatchGroup> for DispatchGroup

fn as_ref(&self) -> &Self

Converts this type into a shared reference of the (usually inferred) input type.

impl Debug for DispatchGroup

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

Formats the value using the given formatter.

impl DispatchObject for DispatchGroup

fn retain(&self) -> DispatchRetained<Self>

Increment the reference count of the object.

fn context(&self) -> *mut c_void

TODO.

unsafe fn set_context(&self, context: *mut c_void)

TODO.

unsafe fn set_finalizer_f(&self, finalizer: dispatch_function_t)

TODO.

fn set_finalizer<F>(&self, destructor: F)

where F: Send + FnOnce(),

Set the finalizer function for the object.

unsafe fn set_target_queue(&self, queue: &DispatchQueue)

Set the target DispatchQueue of this object.

unsafe fn set_qos_class_floor( &self, qos_class: DispatchQoS, relative_priority: i32, ) -> Result<(), QualityOfServiceClassFloorError>

Set the QOS class floor on a dispatch queue, source or workloop.

fn activate(&self)

Activate the object.

fn suspend(&self)

Suspend the invocation of functions on the object.

fn resume(&self)

Resume the invocation of functions on the object.

impl Hash for DispatchGroup

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Message for DispatchGroup

fn retain(&self) -> Retained<Self>

where Self: Sized,

Increment the reference count of the receiver.

impl PartialEq for DispatchGroup

fn eq(&self, other: &Self) -> bool

Compare this [$type] with another using pointer equality.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RefEncode for DispatchGroup

const ENCODING_REF: Encoding = objc2::encode::Encoding::Object

The Objective-C type-encoding for a reference of this type.

impl Eq for DispatchGroup

impl Send for DispatchGroup

impl Sync for DispatchGroup