sh
cargo add --dev codspeed-bencher-compat
Let's start with the example from the Bencher documentation,
creating a benchmark suite for 2 simple functions (in benches/example.rs):
```rust use bencher::{benchmarkgroup, benchmarkmain, Bencher};
fn a(bench: &mut Bencher) { bench.iter(|| { (0..1000).fold(0, |x, y| x + y) }) }
fn b(bench: &mut Bencher) { const N: usize = 1024; bench.iter(|| { vec![0u8; N] });
bench.bytes = N as u64;
}
benchmarkgroup!(benches, a, b); benchmarkmain!(benches); ```
The last step in creating the Bencher benchmark is to add the new benchmark target in your Cargo.toml:
toml title="Cargo.toml"
[[bench]]
name = "example"
harness = false
To allow CodSpeed to interact with this suite as well, you simply need to replace
the imports from the bencher crate to the codspeed-bencher-compat crate:
diff
- use bencher::{benchmark_group, benchmark_main, Bencher};
+ use codspeed_bencher_compat::{benchmark_group, benchmark_main, Bencher};
And that's it! You can now run your benchmark suite with CodSpeed:
``` $ cargo codspeed build Finished release [optimized] target(s) in 0.12s Finished built 1 benchmark suite(s)
$ cargo codspeed run Collected 1 benchmark suite(s) to run Running example Using codspeed-bencher-compat v1.0.0 compatibility layer NOTICE: codspeed is enabled, but no performance measurement will be made since it's running in an unknown environment. Checked: benches/example.rs::a (group: benches) Checked: benches/example.rs::b (group: benches) Done running bencher_example Finished running 1 benchmark suite(s) ```