Struct crux_core::testing::AppTester

pub struct AppTester<App, Ef>
where
    App: App,
{ /* private fields */ }

AppTester is a simplified execution environment for Crux apps for use in tests.

Create an instance of AppTester with your App and an Effect type using AppTester::default.

for example:

let app = AppTester::<ExampleApp, ExampleEffect>::default();

Implementations

impl<App, Ef> AppTester<App, Ef>

where App: App,

pub fn new(app: App) -> Self

where Ef: Send + 'static, App::Capabilities: WithContext<App::Event, Ef>,

Create an AppTester instance for an existing app instance. This can be used if your App has a constructor other than Default, for example when used as a child app and expecting configuration from the parent

pub fn update( &self, event: App::Event, model: &mut App::Model, ) -> Update<Ef, App::Event>

Run the app’s update function with an event and a model state

You can use the resulting Update to inspect the effects which were requested and potential further events dispatched by capabilities.

pub fn resolve<Op: Operation>( &self, request: &mut Request<Op>, value: Op::Output, ) -> Result<Update<Ef, App::Event>>

Resolve an effect request from previous update with an operation output.

This potentially runs the app’s update function if the effect is completed, and produce another Update.

pub fn view(&self, model: &App::Model) -> App::ViewModel

Run the app’s view function with a model state

Trait Implementations

impl<App, Ef> AsRef<<App as App>::Capabilities> for AppTester<App, Ef>

where App: App,

fn as_ref(&self) -> &App::Capabilities

Converts this type into a shared reference of the (usually inferred) input type.

impl<App, Ef> Default for AppTester<App, Ef>

where App: App, App::Capabilities: WithContext<App::Event, Ef>, Ef: Send + 'static,

fn default() -> Self

Returns the “default value” for a type.