Struct criterion::BenchmarkId
source · [−]pub struct BenchmarkId { /* private fields */ }
Expand description
Simple structure representing an ID for a benchmark. The ID must be unique within a benchmark group.
Implementations
sourceimpl BenchmarkId
impl BenchmarkId
sourcepub fn new<S: Into<String>, P: Display>(
function_name: S,
parameter: P
) -> BenchmarkId
pub fn new<S: Into<String>, P: Display>(
function_name: S,
parameter: P
) -> BenchmarkId
Construct a new benchmark ID from a string function name and a parameter value.
Note that the parameter value need not be the same as the parameter passed to your actual benchmark. For instance, you might have a benchmark that takes a 1MB string as input. It would be impractical to embed the whole string in the benchmark ID, so instead your parameter value might be a descriptive string like “1MB Alphanumeric”.
Examples
// A basic benchmark ID is typically constructed from a constant string and a simple
// parameter
let basic_id = BenchmarkId::new("my_id", 5);
// The function name can be a string
let function_name = "test_string".to_string();
let string_id = BenchmarkId::new(function_name, 12);
// Benchmark IDs are passed to benchmark groups:
let mut criterion = Criterion::default();
let mut group = criterion.benchmark_group("My Group");
// Generate a very large input
let input : String = ::std::iter::repeat("X").take(1024 * 1024).collect();
// Note that we don't have to use the input as the parameter in the ID
group.bench_with_input(BenchmarkId::new("Test long string", "1MB X's"), &input, |b, i| {
b.iter(|| i.len())
});
sourcepub fn from_parameter<P: Display>(parameter: P) -> BenchmarkId
pub fn from_parameter<P: Display>(parameter: P) -> BenchmarkId
Construct a new benchmark ID from just a parameter value. Use this when benchmarking a single function with a variety of different inputs.
Trait Implementations
sourceimpl Clone for BenchmarkId
impl Clone for BenchmarkId
sourcefn clone(&self) -> BenchmarkId
fn clone(&self) -> BenchmarkId
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Hash for BenchmarkId
impl Hash for BenchmarkId
sourceimpl PartialEq<BenchmarkId> for BenchmarkId
impl PartialEq<BenchmarkId> for BenchmarkId
sourcefn eq(&self, other: &BenchmarkId) -> bool
fn eq(&self, other: &BenchmarkId) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
impl Eq for BenchmarkId
impl StructuralEq for BenchmarkId
impl StructuralPartialEq for BenchmarkId
Auto Trait Implementations
impl RefUnwindSafe for BenchmarkId
impl Send for BenchmarkId
impl Sync for BenchmarkId
impl Unpin for BenchmarkId
impl UnwindSafe for BenchmarkId
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
sourcefn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Compare self to key
and return true
if they are equal.