yield-progress 0.2.0

Combined progress reporting and cooperative task yielding.
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

use std::time::Duration;

use yield_progress::YieldProgress;

#[tokio::main(flavor = "current_thread")]
async fn main() {
    let p = yield_progress::Builder::new()
        .yield_using(|_| tokio::task::yield_now())
        .progress_using(progress_bar())
        .build();

    let task_handle = tokio::task::spawn(cancellable_task(p));

    // Either wait for task to complete or cancel it.
    {
        let ctrlc = tokio::signal::ctrl_c();
        let abort_handle = task_handle.abort_handle();
        tokio::select! {
            _ = ctrlc => {
                abort_handle.abort()
            }
            _ = task_handle => {
                // Task is complete; drop the ctrlc watcher
            }
        }
    }

    println!("Exiting main().");
}

async fn cancellable_task(p: YieldProgress) {
    let length = 1000;
    for i in 0..length {
        p.progress(i as f32 / length as f32).await;
        tokio::time::sleep(Duration::from_micros(100)).await;
    }
    p.finish().await;
}

fn progress_bar() -> impl Fn(&yield_progress::ProgressInfo<'_>) {
    // TODO: print label; don't print again if the output would be identical text
    move |info| {
        let width = (info.fraction() * 80.0) as usize;
        print!("\r{blank:X<width$}", blank = "");
    }
}