mirror of
https://github.com/Cuprate/cuprate.git
synced 2024-12-23 03:59:31 +00:00
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
* 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
14 lines
583 B
Markdown
14 lines
583 B
Markdown
## `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`.
|