Skip to main content

Bencher

Struct Bencher 

Source
pub struct Bencher { /* private fields */ }
Expand description

The Bencher provides iteration control for benchmarks.

Uses Criterion-style batched sampling:

  • Warmup phase estimates iteration time
  • Measurement phase batches iterations into samples
  • Each sample = average of many iterations (reduces noise)

Implementations§

Source§

impl Bencher

Source

pub fn new(track_allocations: bool) -> Self

Create a new Bencher

Source

pub fn with_config(track_allocations: bool, target_samples: usize) -> Self

Create a Bencher with custom sample count

Source

pub fn set_iters_per_sample(&mut self, iters: u64)

Set iterations per sample (called after warmup estimation)

Source

pub fn estimated_iter_time_ns(&self) -> Option<u64>

Get estimated iteration time from warmup (in nanoseconds)

Source

pub fn start_measurement(&mut self, measurement_time_ns: u64)

Transition from warmup to measurement phase

Source

pub fn iter<T, F>(&mut self, f: F)
where F: FnMut() -> T,

Run the benchmark closure for one iteration.

During warmup: records individual timings for estimation. During measurement: accumulates into batched samples.

Source

pub fn iter_with_setup<T, S, F, R>(&mut self, setup: S, routine: F)
where S: FnMut() -> T, F: FnMut(T) -> R,

Run the benchmark with separate setup phase

Source

pub fn iter_batched<T, S, F, R>( &mut self, batch_size: u64, setup: S, routine: F, )
where S: FnMut() -> T, F: FnMut(&T) -> R,

Run benchmark with batched iterations (user-specified batch size)

Source

pub fn iter_async_standalone<T, F, Fut>(&mut self, f: F)
where F: FnMut() -> Fut, Fut: Future<Output = T>,

Run an async benchmark closure (standalone - creates its own runtime)

Source

pub fn iter_async<T, F, Fut>(&mut self, f: F)
where F: FnMut() -> Fut, Fut: Future<Output = T>,

Run an async benchmark closure within an existing tokio runtime

Source

pub fn has_enough_samples(&self) -> bool

Check if we’ve collected enough samples

Source

pub fn samples(&self) -> &[Sample]

Get collected samples

Source

pub fn take_samples(&mut self) -> Vec<Sample>

Take ownership of collected samples (clears warmup data)

Source

pub fn iteration_count(&self) -> u64

Get total iteration count

Source

pub fn target_samples(&self) -> usize

Get target sample count

Source

pub fn finish(self) -> BenchmarkResult

Finalize and return results

Auto Trait Implementations§

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> ArchivePointee for T

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
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> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
Source§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

Source§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
Source§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The metadata type for pointers and references to this type.
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.