Struct TaskGroup

pub struct TaskGroup {
    inner: Arc<TaskGroupInner>,
}

A group of task working together

Using this struct it is possible to spawn one or more main thread collaborating, which can cooperatively gracefully shut down, either due to external request, or failure of one of them.

Each thread should periodically check TaskHandle or rely on condition like channel disconnection to detect when it is time to finish.

Fields

inner: Arc<TaskGroupInner>

Implementations

impl TaskGroup

pub fn new() -> Self

pub fn make_handle(&self) -> TaskHandle

pub fn make_subgroup(&self) -> Self

Create a sub-group

Task subgroup works like an independent TaskGroup, but the parent TaskGroup will propagate the shut down signal to a sub-group.

In contrast to using the parent group directly, a subgroup allows calling Self::join_all and detecting any panics on just a subset of tasks.

The code create a subgroup is responsible for calling Self::join_all. If it won’t, the parent subgroup will not detect any panics in the tasks spawned by the subgroup.

pub fn shutdown(&self)

Tell all tasks in the group to shut down. This only initiates the shutdown process, it does not wait for the tasks to shut down.

pub async fn shutdown_join_all( self, join_timeout: impl Into<Option<Duration>>, ) -> Result<(), Error>

Tell all tasks in the group to shut down and wait for them to finish.

pub fn install_kill_handler(&self)

Add a task to the group that waits for CTRL+C or SIGTERM, then tells the rest of the task group to shut down.

pub fn spawn<Fut, R>( &self, name: impl Into<String>, f: impl FnOnce(TaskHandle) -> Fut + MaybeSend + 'static, ) -> Receiver<R>

where Fut: Future<Output = R> + MaybeSend + 'static, R: MaybeSend + 'static,

pub fn spawn_cancellable<R>( &self, name: impl Into<String>, future: impl Future<Output = R> + MaybeSend + 'static, ) -> Receiver<Result<R, ShuttingDownError>>

where R: MaybeSend + 'static,

Spawn a task that will get cancelled automatically on TaskGroup shutdown.

pub async fn join_all(self, timeout: Option<Duration>) -> Result<(), Error>

pub fn join_all_inner<'life0, 'async_recursion>( self, deadline: Option<SystemTime>, errors: &'life0 mut Vec<JoinError>, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_recursion>>

where 'life0: 'async_recursion,

Trait Implementations

impl Clone for TaskGroup

fn clone(&self) -> TaskGroup

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TaskGroup

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

Formats the value using the given formatter.

impl Default for TaskGroup

fn default() -> TaskGroup

Returns the “default value” for a type.