Struct SimFlow 

pub struct SimFlow<'a> { /* private fields */ }

Available on crate feature sim and stageleft_runtime only.

A not-yet-compiled simulator for a Hydro program.

Implementations

impl<'a> SimFlow<'a>

pub fn with_instance<T>( self, thunk: impl FnOnce(CompiledSimInstance<'_>) -> T, ) -> T

Executes the given closure with a single instance of the compiled simulation.

pub fn fuzz(self, thunk: impl AsyncFn(CompiledSimInstance<'_>) + RefUnwindSafe)

Uses a fuzzing strategy to explore possible executions of the simulation. The provided closure will be repeatedly executed with instances of the Hydro program where the batching boundaries, order of messages, and retries are varied.

During development, you should run the test that invokes this function with the cargo sim command, which will use libfuzzer to intelligently explore the execution space. If a failure is found, a minimized test case will be produced in a sim-failures directory. When running the test with cargo test (such as in CI), if a reproducer is found it will be executed, and if no reproducer is found a small number of random executions will be performed.

pub fn exhaustive( self, thunk: impl AsyncFn(CompiledSimInstance<'_>) + RefUnwindSafe, ) -> usize

Exhaustively searches all possible executions of the simulation. The provided closure will be repeatedly executed with instances of the Hydro program where the batching boundaries, order of messages, and retries are varied.

Exhaustive searching is feasible when the inputs to the Hydro program are finite and there are no dataflow loops that generate infinite messages. Exhaustive searching provides a stronger guarantee of correctness than fuzzing, but may take a long time to complete. Because no fuzzer is involved, you can run exhaustive tests with cargo test.

Returns the number of distinct executions explored.

pub fn compiled(self) -> CompiledSim

Compiles the simulation into a dynamically loadable library, and returns a handle to it.