progress-rs 0.3.1

Display a progressbar on the terminal
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

use progress::Progress;

/// **Deprecation**: Using this directly as `progress::builder::ProgressBuilder`
/// is deprecated, please use `progress::Builder` instead.
#[derive(Default)]
#[deprecated(since = "0.3.0", note = "Use Progress::new() instead")]
pub struct ProgressBuilder {
    starting_value: Option<usize>,
    ending_value: Option<usize>,

    caption: Option<String>,
}

#[allow(deprecated)]
impl ProgressBuilder {
    /// Creates a new `Builder` with default values.
    pub fn new() -> Self {
        ProgressBuilder::default()
    }

    /// Will build the `Progress`.
    pub fn build(self) -> Progress {
        Progress::new(
            self.caption.unwrap_or_else(|| "Progress".to_string()),
            self.starting_value.unwrap_or(0),
            self.ending_value.unwrap_or(100),
        )
    }

    /// Sets the starting value of the `Progress`.
    pub fn set_start(self, v: usize) -> Self {
        ProgressBuilder {
            starting_value: Some(v),
            ..self
        }
    }

    /// Sets the maximum value of the `Progress`.
    pub fn set_finish(self, v: usize) -> Self {
        ProgressBuilder {
            ending_value: Some(v),
            ..self
        }
    }

    /// Sets the caption for the `Progress`.
    pub fn set_caption(self, v: String) -> Self {
        ProgressBuilder {
            caption: Some(v),
            ..self
        }
    }
}