Struct DiscardingSpawnGroup 

pub struct DiscardingSpawnGroup {
    pub is_cancelled: bool,
    /* private fields */
}

Discarding Spawn Group

A kind of a spawn group that spawns asynchronous tasks that returns nothing, implicitly waits for all spawned tasks to finish before being dropped and releases all the resources before being dropped unless by explicitly calling dont_wait_at_drop()

Child tasks are spawned by calling either spawn_task() or spawn_task_unless_cancelled() methods.

Running child tasks can be cancelled by calling cancel_all() method.

Child tasks spawned to a spawn group execute concurrently, and may be scheduled in any order.

Fields

is_cancelled: bool

A field that indicates if the spawn group has been cancelled

Implementations

impl DiscardingSpawnGroup

pub fn dont_wait_at_drop(&mut self)

Don’t implicity wait for spawned child tasks to finish before being dropped

impl DiscardingSpawnGroup

pub fn new(num_of_threads: usize) -> Self

Instantiates DiscardingSpawnGroup with a specific number of threads to use in the underlying threadpool when polling futures

Parameters

• num_of_threads: number of threads to use

impl DiscardingSpawnGroup

pub fn spawn_task( &mut self, priority: Priority, closure: impl Future<Output = ()> + Send + 'static, )

Spawns a new task into the spawn group

Parameters

• priority: priority to use
• closure: an async closure that doesn’t return anything

pub fn spawn_task_unlessed_cancelled( &mut self, priority: Priority, closure: impl Future<Output = ()> + Send + 'static, )

Spawn a new task only if the group is not cancelled yet, otherwise does nothing

Parameters

• priority: priority to use
• closure: an async closure that return doesn’t return anything

pub fn cancel_all(&mut self)

Cancels all running task in the spawn group

impl DiscardingSpawnGroup

pub fn is_empty(&self) -> bool

A Boolean value that indicates whether the group has any remaining tasks.

At the start of the body of a with_spawn_group() call, , or before calling spawn_task or spawn_task_unless_cancelled methods the spawn group is always empty.

Returns

• true: if there’s no child task still running
• false: if any child task is still running

impl DiscardingSpawnGroup

pub async fn wait_for_all(&mut self)

Waits for all remaining child tasks for finish.

pub fn wait_non_async(&mut self)

Waits for all remaining child tasks for finish in non async context.

Trait Implementations

impl Default for DiscardingSpawnGroup

fn default() -> Self

Instantiates DiscardingSpawnGroup with the number of threads as the number of cores as the system to use in the underlying threadpool when polling futures

impl Drop for DiscardingSpawnGroup

fn drop(&mut self)

Executes the destructor for this type.