task-supervisor 0.3.4

Tokio tasks Supervisor
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65

# 🤖 task-supervisor

[![Crates.io](https://img.shields.io/crates/v/supervisor.svg)](https://crates.io/crates/task-supervisor)
[![Docs.rs](https://docs.rs/supervisor/badge.svg)](https://docs.rs/task-supervisor)

`task-supervisor` helps you keep Tokio tasks alive.
It watches each task, restarts it if it crashes or stops responding, and lets you add, restart, or kill tasks at runtime.

## Install

```bash
cargo add task-supervisor
```

## Quick example

```rust
use async_trait::async_trait;
use task_supervisor::{SupervisorBuilder, SupervisedTask, TaskResult};

#[derive(Clone)]
struct Printer;

#[async_trait]
impl SupervisedTask for Printer {
    async fn run(&mut self) -> TaskResult {
        println!("hello");
        Ok(())
    }
}

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let supervisor = SupervisorBuilder::default()
        .with_task("printer", Printer)
        .build()
        .run();

    supervisor.wait().await?;   // wait until every task finishes or is killed
    Ok(())
}
```

## What you get

* **Automatic restarts** – tasks are relaunched after a crash or hang (exponential back-off).
* **Dynamic control** – add, restart, kill, or query tasks through a `SupervisorHandle`.
* **Configurable** – tune health-check interval, restart limits, back-off delay, and shutdown policy.

## API overview

| TaskHandle method               | Purpose                                                           |
| ------------------------------- | ----------------------------------------------------------------- |
| `add_task(name, task)`          | Start a new task while running                                    |
| `restart(name)`                 | Force a restart                                                   |
| `kill_task(name)`               | Stop a task permanently                                           |
| `get_task_status(name).await`   | Return `TaskStatus` (`Healthy`, `Failed`, `Completed`, `Dead`, …) |
| `get_all_task_statuses().await` | Map of all task states                                            |
| `shutdown()`                    | Stop every task and exit                                          |

Full documentation lives on docs.rs.

## License

[MIT](./LICENSE)