sitrep 0.4.0

Frontend-agnostic progress reporting
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

use std::hint::black_box;

use criterion::{criterion_group, criterion_main, Criterion};

use sitrep::{
    test_utils::{make_hierarchy, make_stand_alone},
    Generation, Reporter, Task,
};

const ITERATIONS: usize = 10_000;

pub fn stand_alone(c: &mut Criterion) {
    c.bench_function("partial_report(): stand-alone", |b| {
        let (progress, reporter) = make_stand_alone(None);

        // Make sure we actually have stuff to compute for the report:
        progress.update(|task: &mut Task| {
            task.label = Some("label".into());
            task.completed = 1;
            task.total = 10;
        });

        let reporter = reporter.upgrade().unwrap();

        b.iter(|| {
            let mut last_change = Generation::MIN;

            for _ in 0..ITERATIONS {
                progress.update(|_| ());

                let report = reporter.partial_report(last_change).unwrap();

                last_change = report.last_change();

                black_box(report);
            }
        });

        drop(progress);
    });
}

pub fn hierarchical(c: &mut Criterion) {
    c.bench_function("partial_report(): hierarchical", |b| {
        let (progresses, reporter) = make_hierarchy();

        // Make sure we actually have stuff to compute for the report:
        for progress in progresses.iter() {
            progress.update(|task: &mut Task| {
                task.label = Some("label".into());
                task.completed = 1;
                task.total = 10;
            });
        }

        let reporter = reporter.upgrade().unwrap();

        b.iter(|| {
            let mut last_change = Generation::MIN;

            for i in 0..ITERATIONS {
                // Poor man's deterministic pseudo-random sample using a prime-number:
                let idx = (i * 13) % progresses.len();

                progresses[idx].update(|_| ());

                let report = reporter.partial_report(last_change).unwrap();

                last_change = report.last_change();

                black_box(report);
            }
        });

        drop(progresses);
    });
}

criterion_group!(benches, stand_alone, hierarchical);
criterion_main!(benches);