sh
cargo add --dev codspeed-criterion-compat
Let's start with the example from the Criterion.rs documentation,
creating a benchmark suite for the Fibonacci function (in benches/my_benchmark.rs):
```rust use criterion::{blackbox, criteriongroup, criterion_main, Criterion};
fn fibonacci(n: u64) -> u64 { match n { 0 => 1, 1 => 1, n => fibonacci(n-1) + fibonacci(n-2), } }
pub fn criterionbenchmark(c: &mut Criterion) { c.benchfunction("fib 20", |b| b.iter(|| fibonacci(black_box(20)))); }
criteriongroup!(benches, criterionbenchmark); criterion_main!(benches); ```
The last step in creating the Criterion benchmark is to add the new benchmark target in your Cargo.toml:
toml title="Cargo.toml"
[[bench]]
name = "my_benchmark"
harness = false
To allow CodSpeed to interact with this suite as well, you simply need to replace
the imports from the criterion crate to the codspeed-criterion-compat crate:
diff
- use criterion::{black_box, criterion_group, criterion_main, Criterion};
+ use codspeed_criterion_compat::{black_box, criterion_group, criterion_main, Criterion};
And that's it! You can now run your benchmark suite with cargo-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 mybenchmark Using codspeed-criterion-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/bencherexample.rs::fib20 (group: benches) Done running bencherexample Finished running 1 benchmark suite(s) ```