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

pub mod bernoulli;
pub mod clamping;
pub mod mapping;
pub mod timing;

use std::ops::Add;

/// A trait describing basic functionality for simple text-based progress-bars.
///
///
/// # Mini-Examples
///
/// ```
/// use progressing::{
///     bernoulli::Bar as BernoulliBar, clamping::Bar as ClampingBar, mapping::Bar as MappingBar,
///     Baring,
/// };
///
/// /// Printing value 0.3 clamped to [0, 1]
/// /// [=====>------------]
/// fn clamped() {
///     println!("Printing value 0.3 clamped to [0, 1]");
///     let mut progress_bar = ClampingBar::new();
///     progress_bar.set_len(20);
///     progress_bar.set(0.3);
///     println!("{}", progress_bar);
/// }
///
/// /// Mapping from [-9, 5] to [0, 1]
/// /// [================>-] (4 / 5)
/// fn mapped() {
///     println!("Mapping from [-9, 5] to [0, 1]");
///     let mut progress_bar = MappingBar::with_range(-9, 5);
///     progress_bar.set_len(20);
///     progress_bar.set(4);
///     println!("{}", progress_bar);
/// }
///
/// /// Bernoulli-Bar counting successes (42 / 60) and attempts (# 130)
/// /// [============>-----] (42 / 60 # 130)
/// fn bernoulli() {
///     println!("Bernoulli-Bar counting successes (42 / 60) and attempts (# 130)");
///     let mut progress_bar = BernoulliBar::with_goal(60);
///     progress_bar.set_len(20);
///     progress_bar.set((42, 130));
///     println!("{}", progress_bar);
/// }
///
/// fn main() {
///     clamped();
///     println!();
///     mapped();
///     println!();
///     bernoulli();
/// }
/// ```
pub trait Baring {
    type Progress: Add<Output = Self::Progress>;

    fn len(&self) -> usize;

    /// Do not shorten the length before reprinting ("\r") since the line will be overwritten, not cleared.
    ///
    /// `[========>-]` becomes `[====>]==>-]` instead of `[====>]     `.
    fn set_len(&mut self, new_bar_len: usize);

    fn progress(&self) -> Self::Progress;

    /// Sets the progress to the given value
    fn set<P>(&mut self, new_progress: P)
    where
        P: Into<Self::Progress>;

    /// Adds the given progress to the current progress
    fn add<P>(&mut self, delta: P)
    where
        P: Into<Self::Progress>,
    {
        self.set(self.progress() + delta.into());
    }

    fn start(&self) -> Self::Progress;

    fn end(&self) -> Self::Progress;

    fn has_progressed_significantly(&self) -> bool;

    fn remember_significant_progress(&mut self);
}