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

<div align="center">
    <img width="90px" height="auto" src="https://raw.githubusercontent.com/jamesgober/jamesgober/main/media/icons/hexagon-3.svg" alt="Triple Hexagon">
    <br>
    <h1>
        <strong>Benchmark</strong>
        <sup>
            <br>
            <sub>DOCUMENTATION</sub>
            <br>
        </sup>
    </h1>
</div>
<div align="center">
    <sup>
        <a href="../README.md" title="Project Home"><b>HOME</b></a>
        <span>&nbsp;│&nbsp;</span>
        <a href="./API.md" title="API Reference"><b>API</b></a>
        <span>&nbsp;│&nbsp;</span>
        <a href="./features/README.md" title="Feature Flags"><b>FEATURES</b></a>
        <span>&nbsp;│&nbsp;</span>
        <a href="./BENCHMARK.md" title="Performance Benchmark"><b>BENCHMARK</b></a>
        <span>&nbsp;│&nbsp;</span>
        <a href="./METRICS.md" title="Performance Metrics"><b>METRICS</b></a>
        <span>&nbsp;│&nbsp;</span>
        <a href="./platforms/INSTANT.md" title="Platform Timer Notes"><b>PLATFORMS</b></a>
    </sup>
</div>
<br>

## Performance Tests (opt-in)

Perf-sensitive unit tests and benches are skipped by default to avoid host variance. Enable explicitly with both a feature flag and an environment variable:

```bash
# run perf tests (opt-in)
PERF_TESTS=1 cargo test -F perf-tests -- --ignored

# run benches that depend on perf gating
PERF_TESTS=1 cargo bench -F perf-tests
```

Notes:
- The `perf-tests` feature gates perf-sensitive paths in tests/benches.
- The `PERF_TESTS=1` env var is additionally checked inside tests to avoid accidental CI runs.

Quick link: See “How to run perf benchmarks (Criterion)” → [docs/BENCHMARK.md#how-to-run-perf-benchmarks](./BENCHMARK.md#how-to-run-perf-benchmarks)





<!-- // COPYRIGHT
============================================================================ -->
<div align="center">
  <br>
  <h2></h2>
  <sup>COPYRIGHT <small>&copy;</small> 2025 <strong>JAMES GOBER.</strong></sup>
</div>