Skip to main content

Scenario

Struct Scenario 

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

Your workflows and requests, run under seeds. See the module docs.

Implementations§

Source§

impl Scenario

Source

pub fn new(setup: impl Fn(&mut Setup) + Send + Sync + 'static) -> Self

setup runs once per seed, on a fresh machine, and builds that seed’s workflows, requests and checks.

Source

pub fn shards(self, n: u32) -> Self

A fixed shard count (by default the seed picks 1 to 3).

Source

pub fn fault_window(self, d: Duration) -> Self

How long faults are injected, from the start of the simulation (default 2 s of simulated time). Requests may come later.

Source

pub fn crash_every(self, d: Duration) -> Self

Mean time between process crashes in the fault window; zero for none. By default the seed picks none, 150, 400 or 900 ms.

Source

pub fn flush_failures_per_mille(self, n: u32) -> Self

Flushes that fail, per thousand, in the fault window. By default the seed picks 0, 2 or 10.

Source

pub fn torn_writes(self, on: bool) -> Self

Whether a crash tears unflushed writes (default true) or only loses them.

Source

pub fn no_faults(self) -> Self

No crashes and no failed flushes: the scheduler and the clock only.

Source

pub fn settle_within(self, d: Duration) -> Self

Simulated time every workflow gets to finish once faults stop (default one hour). Workflows that sleep longer need more.

Source

pub fn config(&self, seed: u64) -> SimConfig

The configuration seed seed runs with.

Source

pub fn run(&self, seed: u64) -> Result<Report, Failure>

Runs one seed. The same seed reproduces the same run, so a failing seed is a test case.

Source

pub fn run_seeds( &self, seeds: impl IntoIterator<Item = u64>, ) -> Result<Summary, Failure>

Runs every seed, stopping at the first failure.

Trait Implementations§

Source§

impl Clone for Scenario

Source§

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

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

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.