rbenchmark 0.1.0

Library for evaluating the performance of your computer
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

//! Trait for own benchmarks

pub mod cpu;
pub mod macros;

/// Trait for own benchmarks
///
/// Use **[core::marker::Send]** and **[core::marker::Sync]**
///
/// # Example
///
/// ```no_run
/// use rbenchmark::prelude::*;
///
/// #[derive(Default)]
/// pub struct MyBenchmark {
///     // Some data
/// }
///
/// impl Benchmark for MyBenchmark {
///     fn run_iter(&self) -> anyhow::Result<()> {
///         // Work...
///
///         Ok(())
///     }
///
///     fn name(&self) -> &'static str {
///         "my benchmark"
///     }
/// }
/// ```
pub trait Benchmark: Send + Sync {
    /// After each cycle of this code, you will add one point
    fn run_iter(&self) -> anyhow::Result<()>;

    /// Return name benchmark
    fn name(&self) -> &'static str;
}