cli-status-board 0.2.5

Simple and thread-safe CLI visualization of async jobs
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

# CLI Status Board

Quickly visualize ongoing asynchronous tasks on the command line.

![demo](images/demo.gif)

## Usage

```rust
use cli_status_board::{SBStateConfig, SBState, Status};

fn main() {
    let state = SBState::new(SBStateConfig::default());

    // Add some arbitrary task with an initial status.
    let task_id = state.add_task(format!("Some super basic task"), Status::Queued);

    // Update the task's status.
    state.update_task(&task_id, Status::Started);

    // TaskId does reference counting so that when the last one drops
    // the task completes automatically. Or you can do so explicitly:
    state.update_task(&task_id, Status::Finished);
}
```

## Examples

See the examples directory. The demo example can be run with:

```sh
cargo run --example demo
```