iter-progress 0.8.0

Calculate progress of your iterators
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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134

use super::*;

#[test]
fn test_simple() {
    use super::ProgressableIter;
    use std::time::Duration;

    let mut progressor = (0..).progress();

    // 0
    let (state, _) = progressor.next().unwrap();
    let mut fake_now = state.started_iterating().clone();

    // It'll always print on the first one
    assert_eq!(state.should_do_every_n_items(2), true);
    assert_eq!(state.should_do_every_n_items(3), true);
    assert_eq!(state.should_do_every_n_items(5), true);
    // First run, so there should be nothing here
    assert!(state.previous_record_tm().is_none());

    // 1 +500ms
    fake_now += Duration::from_millis(500);
    progressor.set_fake_now(fake_now.clone());
    let (state, _) = progressor.next().unwrap();

    assert_eq!(state.rate().round(), 4.0);

    assert_eq!(state.should_do_every_n_sec(1.), false);
    assert_eq!(state.should_do_every_n_sec(2.), false);
    assert_eq!(state.should_do_every_n_sec(0.3), true);

    // 2 +1sec
    fake_now += Duration::from_millis(500);
    progressor.set_fake_now(fake_now.clone());
    let (state, _) = progressor.next().unwrap();

    assert_eq!(state.should_do_every_n_items(2), true);
    assert_eq!(state.should_do_every_n_items(3), false);
    assert_eq!(state.should_do_every_n_items(5), false);
    assert_eq!(state.rate().round(), 3.);
    assert_eq!(state.should_do_every_n_sec(1.), true);
    assert_eq!(state.should_do_every_n_sec(2.), false);
    assert_eq!(state.should_do_every_n_sec(0.8), true);

    // 3 +1.5sec
    fake_now += Duration::from_millis(500);
    progressor.set_fake_now(fake_now.clone());
    let (state, _) = progressor.next().unwrap();
    assert_eq!(state.should_do_every_n_items(2), false);
    assert_eq!(state.should_do_every_n_items(3), true);
    assert_eq!(state.should_do_every_n_items(5), false);
    assert_eq!(state.rate().round(), 3.);
    assert_eq!(state.should_do_every_n_sec(1.), false);
    assert_eq!(state.should_do_every_n_sec(2.), false);
    assert_eq!(state.should_do_every_n_sec(0.8), false);
    assert_eq!(state.should_do_every_n_sec(1.5), true);

    // 4 +2sec
    fake_now += Duration::from_millis(500);
    progressor.set_fake_now(fake_now.clone());
    let (state, _) = progressor.next().unwrap();
    assert_eq!(state.should_do_every_n_items(2), true);
    assert_eq!(state.should_do_every_n_items(3), false);
    assert_eq!(state.should_do_every_n_items(4), true);
    assert_eq!(state.should_do_every_n_items(5), false);
    assert_eq!(state.rate().round(), 3.);
}

#[test]
fn test_size_hint() {
    use super::ProgressableIter;

    let vec: Vec<u8> = vec![0, 1, 2, 3, 4];
    let mut progressor = vec.iter().progress();

    let (state, _) = progressor.next().unwrap();
    assert_eq!(state.fraction(), Some(0.2));
    assert_eq!(state.percent(), Some(20.));

    let (state, _) = progressor.next().unwrap();
    assert_eq!(state.fraction(), Some(0.4));
    assert_eq!(state.percent(), Some(40.));

    let mut progressor = (0..).progress();

    let (state, val) = progressor.next().unwrap();
    assert_eq!(val, 0);
    assert_eq!(state.fraction(), None);
    let (state, val) = progressor.next().unwrap();
    assert_eq!(val, 1);
    assert_eq!(state.fraction(), None);
}

#[test]
fn assume_fraction1() {
    use super::ProgressableIter;

    let vec: Vec<u8> = vec![0, 1, 2, 3, 4];
    let mut progressor = vec.iter().progress();

    let (mut state, _) = progressor.next().unwrap();
    assert_eq!(state.fraction(), Some(0.2));
    assert_eq!(state.percent(), Some(20.));
    state.assume_fraction(0.5);
    assert_eq!(state.fraction(), Some(0.5));
    assert_eq!(state.percent(), Some(50.));

    let (state, _) = progressor.next().unwrap();
    assert_eq!(state.fraction(), Some(0.4));
    assert_eq!(state.percent(), Some(40.));

    let mut progressor = (0..).progress();

    let (mut state, val) = progressor.next().unwrap();
    assert_eq!(val, 0);
    assert_eq!(state.fraction(), None);
    state.assume_fraction(0.2);
    assert_eq!(state.fraction(), Some(0.2));
    let (state, val) = progressor.next().unwrap();
    assert_eq!(val, 1);
    assert_eq!(state.fraction(), None);
}

#[test]
fn optional() {
    let vec: Vec<u8> = vec![0, 1, 2, 3, 4];
    let progressed_iterator = vec.iter().optional_progress(3).collect::<Vec<_>>();
    dbg!(&progressed_iterator);
    assert!(progressed_iterator[0].0.is_none());
    assert!(progressed_iterator[1].0.is_none());
    assert!(progressed_iterator[2].0.is_some());
    assert!(progressed_iterator[3].0.is_none());
    assert!(progressed_iterator[4].0.is_none());
}