benchmarking 0.4.13

This crate can be used to execute something and measure the execution time. It does not output anything to screens and filesystems.
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

use std::time::{Duration, Instant};

use crate::{black_box, MeasureResult};

#[derive(Debug, Default)]
/// To measure the execution time.
pub struct Measurer {
    pub(crate) seq:    u128,
    pub(crate) result: Option<MeasureResult>,
    pub(crate) pass:   bool,
}

impl Measurer {
    #[inline]
    /// Get the sequence of the current measurement.
    pub fn get_seq(&self) -> u128 {
        self.seq
    }

    #[inline]
    /// Get the result.
    pub fn get_result(&self) -> Option<&MeasureResult> {
        self.result.as_ref()
    }

    #[inline]
    /// Check this measurer whether it is measured.
    pub fn is_measured(&self) -> bool {
        self.result.is_none()
    }

    #[inline]
    /// Check this measurer whether it is passed.
    pub fn is_passed(&self) -> bool {
        self.pass
    }

    #[inline]
    fn update(&mut self, elapsed: Duration) {
        match &mut self.result {
            Some(result) => {
                result.times += 1;

                result.total_elapsed += elapsed;
            },
            None => {
                self.result = Some(MeasureResult::new(elapsed));
            },
        }
    }

    #[inline]
    /// Measure a function by executing it once.
    pub fn measure<M, K>(&mut self, f: M)
    where
        M: FnOnce() -> K, {
        let start = Instant::now();

        black_box(f());

        self.update(start.elapsed());
    }

    #[inline]
    /// Pass the current measurement.
    pub fn pass(&mut self) {
        self.pass = true;
    }
}