cuprate/benches/benchmark/lib/README.md
hinto-janai caa08d5eaa
Some checks failed
Architecture mdBook / build (push) Has been cancelled
CI / fmt (push) Has been cancelled
CI / typo (push) Has been cancelled
CI / ci (macos-latest, stable, bash) (push) Has been cancelled
CI / ci (ubuntu-latest, stable, bash) (push) Has been cancelled
CI / ci (windows-latest, stable-x86_64-pc-windows-gnu, msys2 {0}) (push) Has been cancelled
Deny / audit (push) Has been cancelled
Doc / build (push) Has been cancelled
Doc / deploy (push) Has been cancelled
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

709 B

cuprate-benchmark-lib

This crate is the glue between cuprate-benchmark and all the benchmark crates.

It defines the [crate::Benchmark] trait, which is the behavior of all benchmarks.

See the cuprate-benchmark-example crate to see an example implementation of this trait.

After implementing this trait, a few steps must be done such that the cuprate-benchmark binary can actually run your benchmark crate; see the Benchmarking section in the Architecture book to see how to do this.