Skip to main content

BenchProducer

Struct BenchProducer 

Source
pub struct BenchProducer<F>
where F: Fn() -> BenchmarkResult,
{ /* private fields */ }
Expand description

Producer wrapper that runs a benchmark and emits a single-check Report via Producer::produce.

§Example

use dev_bench::{Benchmark, BenchProducer, Threshold};
use dev_report::Producer;

fn run_bench() -> dev_bench::BenchmarkResult {
    let mut b = Benchmark::new("hot_path");
    for _ in 0..10 { b.iter(|| std::hint::black_box(1 + 1)); }
    b.finish()
}

let producer = BenchProducer::new(run_bench, "0.1.0", None, Threshold::regression_pct(10.0));
let report = producer.produce();
assert_eq!(report.checks.len(), 1);

Implementations§

Source§

impl<F> BenchProducer<F>
where F: Fn() -> BenchmarkResult,

Source

pub fn new( run: F, subject_version: impl Into<String>, baseline_mean: Option<Duration>, threshold: Threshold, ) -> Self

Build a new producer.

Trait Implementations§

Source§

impl<F> Producer for BenchProducer<F>
where F: Fn() -> BenchmarkResult,

Source§

fn produce(&self) -> Report

Run the producer and return a finalized report. Read more

Auto Trait Implementations§

§

impl<F> Freeze for BenchProducer<F>
where F: Freeze,

§

impl<F> RefUnwindSafe for BenchProducer<F>
where F: RefUnwindSafe,

§

impl<F> Send for BenchProducer<F>
where F: Send,

§

impl<F> Sync for BenchProducer<F>
where F: Sync,

§

impl<F> Unpin for BenchProducer<F>
where F: Unpin,

§

impl<F> UnsafeUnpin for BenchProducer<F>
where F: UnsafeUnpin,

§

impl<F> UnwindSafe for BenchProducer<F>
where F: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.