Struct Bencher 

pub struct Bencher<R> { /* private fields */ }

A benchmarking harness.

Implementations

impl<R: Runtime> Bencher<R>

pub fn new(threads: usize, runtime: R) -> Self

Create a new benchmark harness.

Examples

use blueprint_benchmarking::{Bencher, TokioRuntime};

const THREADS: usize = 4;

let bencher = Bencher::new(THREADS, TokioRuntime);

pub fn block_on<F>(&self, future: F) -> F::Output

where F: Future,

Runs the given future on the Runtime.

Examples

use blueprint_benchmarking::{Bencher, TokioRuntime};

const THREADS: usize = 4;

let bencher = Bencher::new(THREADS, TokioRuntime);
bencher.block_on(async {
    // Do some work...
});

pub fn stop<N: ToString>(&self, name: N, job_id: u8) -> BenchmarkSummary

Ends the benchmark and returns a summary.

Panics

This will panic in the event it cannot determine the process ID.

Examples

use blueprint_benchmarking::{Bencher, TokioRuntime};
const THREADS: usize = 4;

let bencher = Bencher::new(THREADS, TokioRuntime);
bencher.block_on(async {
    // Do some work...
});

let summary = bencher.stop("my_benchmark", 0);
println!("{}", summary);

Trait Implementations

impl<R: Debug> Debug for Bencher<R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.