nutmeg 0.1.6

An unopinionated progress bar 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

// Copyright 2022 Martin Pool

//! Helpful functions for drawing progress bars.

use std::time::{Duration, Instant};

fn duration_brief(d: Duration) -> String {
    let secs = d.as_secs();
    if secs >= 120 {
        format!("{} min", secs / 60)
    } else {
        format!("{secs} sec")
    }
}

/// Estimate by linear extrapolation the time remaining for a task with a given
/// start time, number of completed items and number of total items.
///
/// The result is in the format "33 sec" or "12 min". This format may change in
/// future releases before 1.0.
///
/// If the remaining time is not estimatable, returns "??".
pub fn estimate_remaining(start: &Instant, done: usize, total: usize) -> String {
    let elapsed = start.elapsed();
    if total == 0 || done == 0 || elapsed.is_zero() || done > total {
        "??".into()
    } else {
        let done = done as f64;
        let total = total as f64;
        let estimate = Duration::from_secs_f64(elapsed.as_secs_f64() * (total / done - 1.0));
        duration_brief(estimate)
    }
}

/// Return a string representation of the percentage of work completed.
///
/// ```
/// use nutmeg::percent_done;
/// assert_eq!(percent_done(6, 12), "50.0%");
/// assert_eq!(percent_done(0, 0), "??%");
/// ```
pub fn percent_done(done: usize, total: usize) -> String {
    if total == 0 || done > total {
        "??%".into()
    } else {
        format!("{:.1}%", done as f64 * 100.0 / total as f64)
    }
}