Struct madsim::runtime::Builder

pub struct Builder {
    pub seed: u64,
    pub count: u64,
    pub jobs: u16,
    pub config: Config,
    pub time_limit: Option<Duration>,
    pub check: bool,
    pub allow_system_thread: bool,
}

Available on madsim only.

Builds Madsim Runtime with custom configuration values.

Fields

seed: u64

The random seed for test.

count: u64

The number of tests.

jobs: u16

The number of jobs to run simultaneously.

config: Config

The configuration.

time_limit: Option<Duration>

The time limit for the test.

check: bool

Enable determinism check.

allow_system_thread: bool

Allow spawning system thread.

Implementations

impl Builder

pub fn from_env() -> Self

Create a new builder from the following environment variables:

• MADSIM_TEST_SEED: Set the random seed for test.

  By default, the seed is set to the seconds since the Unix epoch.

• MADSIM_TEST_NUM: Set the number of tests.

  The seed will increase by 1 for each test.

  By default, the number is 1.

• MADSIM_TEST_JOBS: Set the number of jobs to run simultaneously.

  By default, the number of jobs is 1.

• MADSIM_TEST_CONFIG: Set the config file path.

  By default, tests will use the default configuration.

• MADSIM_TEST_TIME_LIMIT: Set the time limit for the test.

  The test will panic if time limit exceeded in the simulation.

  By default, there is no time limit.

• MADSIM_TEST_CHECK_DETERMINISM: Enable determinism check.

  The test will be run at least twice with the same seed. If any non-determinism detected, it will panic as soon as possible.

  By default, it is disabled.

• MADSIM_ALLOW_SYSTEM_THREAD: Allow spawning system thread.

  Spawning system thread may cause the test to be non-deterministic.

  By default, it is disallowed.

pub fn run<F>(self, f: fn() -> F) -> F::Output

where F: Future + 'static, F::Output: Send,

Run the future with configurations.