4 releases

0.2.2 Mar 3, 2022
0.2.1 Sep 15, 2021
0.2.0 Apr 2, 2021
0.1.0 Mar 29, 2021

#556 in Data structures

Download history 477/week @ 2024-07-19 402/week @ 2024-07-26 354/week @ 2024-08-02 235/week @ 2024-08-09 580/week @ 2024-08-16 496/week @ 2024-08-23 322/week @ 2024-08-30 544/week @ 2024-09-06 728/week @ 2024-09-13 681/week @ 2024-09-20 551/week @ 2024-09-27 562/week @ 2024-10-04 123/week @ 2024-10-11 316/week @ 2024-10-18 307/week @ 2024-10-25 116/week @ 2024-11-01

916 downloads per month

MIT/Apache

23KB
477 lines

task-group

A small crate for managing groups of tokio tasks.


let (task_group, task_manager): (TaskGroup<Error>, TaskManager<_>) = TaskGroup::new();

task_group.clone().spawn("a task", async move {
    task_group.spawn("b task", async move {
        /* all kinds of things */
        Ok(())
    }).await.expect("spawned b");
    Ok(())
}).await.expect("spawned a");

task_manager.await.expect("everyone successful");

A TaskGroup is used to spawn a collection of tasks. The collection has two properties:

  • if any task returns an error or panicks, all tasks are terminated.
  • if the TaskManager returned by TaskGroup::new is dropped, all tasks are terminated.

A TaskManager is used to manage a collection of tasks. There are two things you can do with it:

  • TaskManager impls Future, so you can poll or await on it. It will be Ready when all tasks return Ok(()) and the associated TaskGroup is dropped (so no more tasks can be created), or when any task panicks or returns an Err(E).
  • When a TaskManager is dropped, all tasks it contains are canceled (terminated). So, if you use a combinator like tokio::time::timeout(duration, task_manager).await, all tasks will be terminated if the timeout occurs.

See examples/ and the tests in src/lib.rs for more examples.

Dependencies

~2–7.5MB
~47K SLoC