Lib.rs

Cargo Features

[dependencies]
codspeed-criterion-compat = { version = "2.6.0", default-features = false, features = ["async", "async_futures", "async_smol", "async_tokio", "async_std", "html_reports", "cargo_bench_support", "csv_output", "rayon", "plotters"] }

default = cargo_bench_support, plotters, rayon

These default features are set whenever codspeed-criterion-compat is added without default-features = false somewhere in the dependency tree.

async async_futures? async_smol? async_std? async_tokio? = futures

Criterion.rs features

Enables async of criterion

Affects bencher::AsyncBencher…

async_futures = async

Enables executor of futures and async_futures of criterion

criterion:

These features enable built-in support for running async benchmarks on each different async runtime.

async_smol = async, smol

Enables async_smol of criterion

async_tokio = async, tokio

Enables async_tokio of criterion

async_std = async, async-std

Enables async_std of criterion

html_reports

Enables html_reports of criterion

criterion:

This feature _currently_ does nothing except disable a warning message, but in 0.4.0 it will be required in order to have Criterion.rs generate its own plots (as opposed to using cargo-criterion)

cargo_bench_support default

Enables cargo_bench_support of criterion

criterion:

This feature _currently_ does nothing except disable a warning message, but in 0.4.0 it will be required in order to have Criterion.rs be usable outside of cargo-criterion.

csv_output

Enables csv_output of criterion

criterion:

This feature _currently_ does nothing, but in 0.4.0 it will be required in order to have Criterion.rs generate CSV files. This feature is deprecated in favor of cargo-criterion's --message-format=json option.

rayon default

Enables rayon of criterion

plotters default

Enables plotters of criterion

Features from optional dependencies

In crates that don't use the dep: syntax, optional dependencies automatically become Cargo features. These features may have been created by mistake, and this functionality may be removed in the future.

futures async? async_futures?

smol async_smol?

Enables smol ^1.2

tokio async_tokio?

async-std async_std?