Struct TaskGroup

pub struct TaskGroup {
    tasks: Mutex<Vec<TaskHandler>>,
    stop_signal: Arc<CondWait>,
    executor: Executor,
}

TaskGroup A group that contains spawned tasks.

Example

use std::sync::Arc;

use karyon_core::async_util::{TaskGroup, sleep};

async {
    let group = TaskGroup::new();

    group.spawn(sleep(std::time::Duration::MAX), |_| async {});

    group.cancel().await;

};

Fields

tasks: Mutex<Vec<TaskHandler>>

stop_signal: Arc<CondWait>

executor: Executor

Implementations

impl TaskGroup

pub fn new() -> Self

Creates a new TaskGroup without providing an executor

This will spawn a task onto a global executor (single-threaded by default).

pub fn with_executor(executor: Executor) -> Self

Creates a new TaskGroup by providing an executor

pub fn spawn<T, Fut, CallbackF, CallbackFut>( &self, fut: Fut, callback: CallbackF, )

where T: Send + Sync + 'static, Fut: Future<Output = T> + Send + 'static, CallbackF: FnOnce(TaskResult<T>) -> CallbackFut + Send + 'static, CallbackFut: Future<Output = ()> + Send + 'static,

Spawns a new task and calls the callback after it has completed or been canceled. The callback will have the TaskResult as a parameter, indicating whether the task completed or was canceled.

pub fn is_empty(&self) -> bool

Checks if the TaskGroup is empty.

pub fn len(&self) -> usize

Get the number of the tasks in the group.

pub async fn cancel(&self)

Cancels all tasks in the group.

Trait Implementations

impl Default for TaskGroup

fn default() -> Self

Returns the “default value” for a type.