Git Product home page Git Product logo

task-group's Introduction

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.

task-group's People

Contributors

pchickey avatar aturon avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.