Struct TestLoopV2 

pub struct TestLoopV2 {
    pub data: TestLoopData,
    /* private fields */
}

Main struct for the Test Loop framework. The TestLoopData should contain all the business logic state that is relevant to the test. All possible Event that are sent to the event loop are callbacks. See TestLoopData for mode details.

Events are sent to the testloop, with a possible delay, via the pending_events_sender.

Fields

data: TestLoopData

The data that is stored and accessed by the test loop.

Implementations

impl TestLoopV2

pub fn new() -> Self

pub fn future_spawner(&self, identifier: &str) -> TestLoopFutureSpawner

Returns a FutureSpawner that can be used to spawn futures into the loop.

pub fn async_computation_spawner( &self, identifier: &str, artificial_delay: impl Fn(&str) -> Duration + Send + Sync + 'static, ) -> TestLoopAsyncComputationSpawner

Returns an AsyncComputationSpawner that can be used to spawn async computation into the loop. The artificial_delay allows the test to determine an artificial delay that the computation should take, based on the name of the computation.

pub fn send_adhoc_event( &self, description: String, callback: impl FnOnce(&mut TestLoopData) + Send + 'static, )

Sends any ad-hoc event to the loop.

pub fn send_adhoc_event_with_delay( &self, description: String, delay: Duration, callback: impl FnOnce(&mut TestLoopData) + Send + 'static, )

Sends any ad-hoc event to the loop, after some delay.

pub fn remove_events_with_identifier(&mut self, identifier: &str)

This function is used to filter out all events that belong to a certain identifier. The use case is while shutting down a node, we would like to not execute any more events from that node.

pub fn clock(&self) -> Clock

Returns a clock that will always return the current virtual time.

pub fn set_every_event_callback( &mut self, callback: impl FnMut(&TestLoopData) + 'static, )

pub fn run_for(&mut self, duration: Duration)

Runs the test loop for the given duration. This function may be called multiple times, but further test handlers may not be registered after the first call.

pub fn run_until( &mut self, condition: impl FnMut(&mut TestLoopData) -> bool, maximum_duration: Duration, )

Run until the given condition is true, asserting that it happens before the maximum duration is reached.

To maximize logical consistency, the condition is only checked before the clock would advance. If it returns true, execution stops before advancing the clock.

pub fn shutdown_and_drain_remaining_events(self, maximum_duration: Duration)

pub fn run_instant(&mut self)

Trait Implementations

impl Drop for TestLoopV2

fn drop(&mut self)

Executes the destructor for this type.