kyuri 0.2.6

A very simple progress display library
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
66
67
68
69
70
71
72
73
74

# kyuri

A progress display library specifically designed for my mirroring softwares ([tsumugu](https://github.com/taoky/tsumugu) & [yukina](https://github.com/taoky/yukina)).

Uses some code from [indicatif](https://github.com/console-rs/indicatif) (MIT).

Docs: [docs.rs/kyuri](https://docs.rs/kyuri)

The API is not stable yet.

## Why?

It could output a progress indicator both when printing to terminal and (especially when) writing to file, with minimal distraction.

And no other dependencies when terminal support is unnecessary. Custom features:

- `console_width` feature: auto-detect terminal width. Otherwise, it's fixed at 80 when in ANSI mode.
- `unicode` feature: calculate the width of Unicode characters correctly. Unnecessary when not in ANSI mode.
- `full`: `console_width` + `unicode`.

If you need a progress bar or spinner with rich and fancy features, use [indicatif](https://github.com/console-rs/indicatif) instead.

## Examples

- [Simple example](examples/progress.rs)

    <img src="https://github.com/taoky/kyuri/blob/master/assets/progress.gif?raw=true" alt="progress">

    ```shell
    cargo run --example progress
    cargo run --example progress > file
    ```

- 2 threads example ([thread](examples/thread.rs), [download](examples/download.rs))

    <img src="https://github.com/taoky/kyuri/blob/master/assets/thread.gif?raw=true" alt="thread">

    ```shell
    cargo run --example thread
    cargo run --example thread > file
    ```

    or this with a different pattern:

    <img src="https://github.com/taoky/kyuri/blob/master/assets/download.gif?raw=true" alt="download">

    ```shell
    cargo run --example download
    cargo run --example download > file
    ```

- Progress bar example

    <img src="https://github.com/taoky/kyuri/blob/master/assets/bar.gif?raw=true" alt="bar">

    ```shell
    cargo run --example bar
    cargo run --example bar > file
    ```

- `tracing` integration example

    <img src="https://github.com/taoky/kyuri/blob/master/assets/tracing.gif?raw=true" alt="tracing">

    ```shell
    cargo run --example tracing
    cargo run --example tracing > file
    ```

---

<img src="https://github.com/taoky/kyuri/blob/master/assets/cucumber.jpg?raw=true" alt="Cucumber from Mutsumi">

(Taken from *[BanG Dream! It's MyGO!!!!!](https://en.wikipedia.org/wiki/MyGO!!!!!)* episode 6.)