benchmark 0.8.0

Nanosecond-precision benchmarking for dev, testing, and production. Zero-overhead core timing when disabled; optional std-powered collectors and zero-dependency metrics (Watch/Timer) for real service observability.
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
135
136
137
138
139
140
141
142
143
144

#![cfg(feature = "std")]

use benchmark::*;

#[test]
fn test_time_named_macro() {
    let (result, m) = time_named!("named_add", 2 + 3);
    assert_eq!(result, 5);
    assert_eq!(m.name, "named_add");

    #[cfg(feature = "benchmark")]
    {
        // Touch duration to avoid lints and ensure it's available
        let _ = m.duration.as_nanos();
    }

    #[cfg(not(feature = "benchmark"))]
    {
        assert_eq!(m.duration.as_nanos(), 0);
        assert_eq!(m.timestamp, 0);
    }
}

#[test]
fn test_benchmark_block_defaults_and_iters() {
    // Default iters (10_000) when benchmark feature is on, else empty vec.
    let samples_default = benchmark_block!({
        let mut x = 0u64;
        x = x.wrapping_add(1);
        let _ = x;
    });

    #[cfg(feature = "benchmark")]
    {
        assert_eq!(samples_default.len(), 10_000);
        // Touch a couple of samples to ensure types and values are usable
        let _ = samples_default[0].as_nanos();
    }

    #[cfg(not(feature = "benchmark"))]
    {
        assert!(samples_default.is_empty());
    }

    // Explicit iters
    let iters = 123usize;
    let samples_iters = benchmark_block!(iters, {
        let mut y = 1u64;
        y = y.wrapping_mul(2);
        let _ = y;
    });

    #[cfg(feature = "benchmark")]
    {
        assert_eq!(samples_iters.len(), iters);
    }

    #[cfg(not(feature = "benchmark"))]
    {
        assert!(samples_iters.is_empty());
    }
}

#[test]
fn test_benchmark_macro_sync_expr_and_block() {
    // Expr form with default iterations
    let (out_default, ms_default) = benchmark!("add", { 2 + 3 });

    #[cfg(feature = "benchmark")]
    {
        assert!(out_default.is_some());
        assert_eq!(out_default.unwrap(), 5);
        assert_eq!(ms_default.len(), 10_000);
        // Ensure Measurement fields are accessible
        let m = &ms_default[0];
        assert_eq!(m.name, "add");
        let _ = m.duration.as_nanos();
    }

    #[cfg(not(feature = "benchmark"))]
    {
        assert_eq!(out_default, Some(5));
        assert!(ms_default.is_empty());
    }

    // iters + expr form
    let (out_iters, ms_iters) = benchmark!("mul", 77usize, { 6 * 7 });

    #[cfg(feature = "benchmark")]
    {
        assert_eq!(out_iters, Some(42));
        assert_eq!(ms_iters.len(), 77);
    }

    #[cfg(not(feature = "benchmark"))]
    {
        assert_eq!(out_iters, Some(42));
        assert!(ms_iters.is_empty());
    }
}

#[tokio::test(flavor = "multi_thread")]
async fn test_time_macro_async() {
    async fn async_add() -> u64 {
        tokio::time::sleep(std::time::Duration::from_millis(1)).await;
        40 + 2
    }

    let (result, d) = time!(async_add().await);
    assert_eq!(result, 42);

    #[cfg(feature = "benchmark")]
    {
        assert!(d.as_millis() >= 1);
    }

    #[cfg(not(feature = "benchmark"))]
    {
        assert_eq!(d.as_nanos(), 0);
    }
}

#[tokio::test(flavor = "multi_thread")]
async fn test_time_named_macro_async() {
    async fn async_mul(a: u64, b: u64) -> u64 {
        tokio::time::sleep(std::time::Duration::from_millis(1)).await;
        a * b
    }

    let (result, m) = time_named!("async_mul", async_mul(6, 7).await);
    assert_eq!(result, 42);
    assert_eq!(m.name, "async_mul");

    #[cfg(feature = "benchmark")]
    {
        assert!(m.duration.as_millis() >= 1);
    }

    #[cfg(not(feature = "benchmark"))]
    {
        assert_eq!(m.duration.as_nanos(), 0);
        assert_eq!(m.timestamp, 0);
    }
}