progressing 3.0.2

A lightweight, text-based, counting progress-bar for Rust
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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112

use progressing::{
    bernoulli::Bar as BernoulliBar, clamping::Bar as ClampingBar, mapping::Bar as MappingBar,
    Baring,
};
use std::{thread, time};

const SLEEP_MS: u64 = 20;

fn main() {
    // different examples for different use-cases
    clamped();
    println!();
    mapped();
    println!();
    bernoulli();
}

fn clamped() {
    let min_value = -80;
    let max_value = 180;

    println!(
        "The bar is running from {} % to {} % clamping to [0, 1].",
        min_value, max_value
    );
    println!(
        "{}{}",
        "Note the respective pause at the beginning and the end, ",
        "which causes the approximated time to be too high."
    );

    // create bar
    let mut progress_bar = ClampingBar::new().timed();

    // do the job and show progress
    for value in min_value..(max_value + 1) {
        progress_bar.set(value as f32 / 100.0);
        if progress_bar.has_progressed_significantly() {
            progress_bar.remember_significant_progress();
            println!("{}", progress_bar);
        }

        // sleep for visual effects ;)
        thread::sleep(time::Duration::from_millis(SLEEP_MS));
    }
    // add new line to finished progress-bar
    println!("{}", progress_bar);
}

fn mapped() {
    let min_value = -10;
    let max_value = 100;
    let min_bar_border = -40;
    let max_bar_border = 140;

    println!(
        "The bar is running from {} to {}, but maps [{}, {}] to [0, 1].",
        min_value, max_value, min_bar_border, max_bar_border
    );
    println!("Note that the bar neither starts nor ends at the bar-borders.");

    // create bar
    let mut progress_bar = MappingBar::with_range(min_bar_border, max_bar_border).timed();

    // do the job and show progress
    for value in min_value..(max_value + 1) {
        progress_bar.set(value);
        if progress_bar.has_progressed_significantly() {
            progress_bar.remember_significant_progress();
            println!("{}", progress_bar);
        }

        // sleep for visual effects ;)
        thread::sleep(time::Duration::from_millis(SLEEP_MS));
    }
    // add new line to finished progress-bar
    println!("{}", progress_bar);
}

fn bernoulli() {
    let min_value = -50;
    let max_value = 120;

    println!(
        "The bar is running from {} to {} counting successes (if value is even) and attempts ({}).",
        min_value,
        max_value,
        (max_value - min_value) + 1
    );
    println!("Note that the bar expects less successes than provided .");

    // create bar
    let mut progress_bar = BernoulliBar::with_goal(60).timed();
    // you can reset the length of it
    progress_bar.set_len(60);

    // do the job and show progress
    for value in min_value..(max_value + 1) {
        // job is successful if value is even
        let is_successful = value % 2 == 0;
        progress_bar.add(is_successful);
        if progress_bar.has_progressed_significantly() {
            progress_bar.remember_significant_progress();
            println!("{}", progress_bar);
        }

        // sleep for visual effects ;)
        thread::sleep(time::Duration::from_millis(SLEEP_MS));
    }
    // add new line to finished progress-bar
    println!("{}", progress_bar);
}