Skip to main content

BenchmarkParams

Struct BenchmarkParams 

pub struct BenchmarkParams { /* private fields */ }
Available on crate feature bench only.
Expand description

The workload sizes a benchmark run uses, chosen by the caller.

Three numbers, one per scenario, and they are parameters rather than constants for a reason the first two adapters make concrete: the batch size, contender count and replay length that say something useful about a Vec behind an RwLock are not the ones that say something useful about a file under BEGIN IMMEDIATE. A constant chosen here would be wrong for at least one of them and unarguable for both.

Implementations§

§

impl BenchmarkParams

pub const SMOKE: Self

The deliberately tiny budget the one-argument macro arm uses.

Sized to live inside the gate’s ordinary cargo test --workspace --all-features step rather than to measure anything: a real number comes from a caller who passed their own params. Keeping the mounted budget small is what stops an executed benchmark from becoming a benchmark that gates.

pub const fn new( batch_size: usize, contenders: usize, replay_events: usize, ) -> Self

Builds a parameter set, refusing a degenerate one by name.

§Panics

Panics if any of batch_size, contenders or replay_events is zero, naming the offending parameter. The refusal is here, before any store is reached, because an empty batch is already refused by the contract — and before the condition is evaluated — so letting one through would turn a caller’s typo into a benchmark of the error path reported as throughput. Zero contenders measures no contention, and zero events to replay measures no replay.

pub const fn batch_size(self) -> usize

How many events one append writes — the n of the throughput scenario.

pub const fn contenders(self) -> usize

How many appends race for one consistency boundary — the k of the contended scenario.

pub const fn replay_events(self) -> usize

How many events are seeded before replay — the N of the replay scenario.

Trait Implementations§

§

impl Clone for BenchmarkParams

§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
§

impl Copy for BenchmarkParams

§

impl Debug for BenchmarkParams

§

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

Formats the value using the given formatter. Read more
§

impl Eq for BenchmarkParams

§

impl PartialEq for BenchmarkParams

§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
§

impl StructuralPartialEq for BenchmarkParams

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> 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
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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.

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V