rskit-util 0.2.0-alpha.1

Pure utility functions for rskit
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

//! Execution timing helpers.

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

/// Runs a synchronous function and returns a tuple containing its return value
/// and the exact execution time.
///
/// # Examples
///
/// ```
/// use rskit_util::time::time_it;
/// let (result, duration) = time_it(|| {
///     // perform some work
///     42
/// });
/// assert_eq!(result, 42);
/// ```
pub fn time_it<F, T>(f: F) -> (T, Duration)
where
    F: FnOnce() -> T,
{
    let start = Instant::now();
    let result = f();
    (result, start.elapsed())
}

/// Returns the non-negative elapsed milliseconds between two monotonic
/// millisecond readings.
#[must_use]
pub const fn elapsed_millis(start: u64, end: u64) -> u64 {
    end.saturating_sub(start)
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_time_it() {
        let (res, elapsed) = time_it(|| 42);
        assert_eq!(res, 42);
        assert!(elapsed <= Duration::from_secs(1));
    }

    #[test]
    fn elapsed_millis_saturates() {
        assert_eq!(elapsed_millis(10, 25), 15);
        assert_eq!(elapsed_millis(25, 10), 0);
    }
}