cuprate-hinto-janai/benches/criterion/example/README.md
hinto-janai caa08d5eaa
benches: initial implementation (#196)
* add readme

* readme, basic examples

* name changes, bin impl

* example, docs

* book

* add `cuprate-criterion-example`

* docs, tracing

* fix clippy

* docs

* lib readme

* json-rpc benchmarks

* add to crates.md

* add `fixme`

* fix `cargo b` failing

this `cfg()` existing makes a regular workspace `cargo b` fail

* fix cargo.toml
2024-11-25 20:10:42 +00:00

583 B

cuprate-criterion-example

An example of using Criterion for benchmarking Cuprate crates.

Consider copy+pasting this crate to use as a base when creating new Criterion benchmark crates.

src/

Benchmark crates have a benches/ ran by cargo bench, but they are also crates themselves, as in, they have a src folder that benches/ can pull code from.

The src directories in these benchmarking crates are usually filled with helper functions, types, etc, that are used repeatedly in the benchmarks.

benches/

These are the actual benchmarks ran by cargo bench.