Skip to main content

StressRun

Struct StressRun 

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

Configuration for a stress run.

§Example

use dev_stress::StressRun;

let run = StressRun::new("hot_path").iterations(1_000).threads(4);
assert_eq!(run.iterations_planned(), 1_000);
assert_eq!(run.threads_planned(), 4);

Implementations§

Source§

impl StressRun

Source

pub fn new(name: impl Into<String>) -> Self

Begin building a stress run with a stable name.

Source

pub fn iterations(self, n: usize) -> Self

Total iterations across all threads.

Source

pub fn threads(self, n: usize) -> Self

Number of OS threads to run concurrently. Minimum is 1.

Source

pub fn track_latency(self, rate: usize) -> Self

Track per-operation latency, sampling 1 of every rate iterations.

rate = 1 records every iteration; rate = 100 records 1% of iterations. Lower rates lower memory and overhead at the cost of percentile precision.

§Example
use dev_stress::StressRun;

let run = StressRun::new("hot").iterations(10_000).threads(2)
    .track_latency(10); // 10% sample rate
assert_eq!(run.iterations_planned(), 10_000);
Source

pub fn iterations_planned(&self) -> usize

The configured iteration count.

Source

pub fn threads_planned(&self) -> usize

The configured thread count.

Source

pub fn execute<W>(&self, workload: &W) -> StressResult
where W: Workload + Clone + 'static,

Execute the run. Returns a result with timing statistics.

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