Struct SimulationBorrow 

pub struct SimulationBorrow<'a, Info: SimulationInfo, StateRef> {
    pub state: StateRef,
    /* private fields */
}

A generic struct representing a borrowed simulation with an immutable or mutable reference to the state.

Fields

state: StateRef

The referenced simulation state.

Trait Implementations

impl<Info: SimulationInfo, S> Deref for SimulationBorrow<'_, Info, S>

type Target = Info

The resulting type after dereferencing.

fn deref(&self) -> &Info

Dereferences the value.

impl<Info: SimulationInfo, S: BorrowMut<Info::State>> Simulation for SimulationBorrow<'_, Info, S>

type StateLoadingError = <Info as SimulationInfo>::StateLoadingError

The error type returned when loading the simulation state fails.

type LoadData = <Info as SimulationInfo>::LoadData

The type of data used to load the simulation state.

fn reload( &mut self, data: Info::LoadData, ) -> Result<(), Info::StateLoadingError>

Reloads the simulation state from the provided data.

unsafe fn call(&mut self, event: Info::Event)

Calls the provided event.

unsafe fn revert(&mut self, event: Info::Event)

Reverts the provided event.

fn try_call(&mut self, event: Self::Event) -> bool

Tries to call the provided event and returns if it was successful.

fn try_revert(&mut self, event: Self::Event) -> bool

Tries to revert the provided event and returns if it was successful.

fn prepare_call(&mut self) -> CallState<'_, Self, Call>

Prepares a safe helper to list callable elements and choose one to call.

fn prepare_revert(&mut self) -> CallState<'_, Self, Revert>

Prepares a safe helper to list revertable elements and choose one to revert.

impl<Info: SimulationInfo, S: Borrow<Info::State>> SimulationState for SimulationBorrow<'_, Info, S>

type AccessData = <Info as SimulationInfo>::AccessData

The type used to access the current state data.

type Event = <Info as SimulationInfo>::Event

The type of events that can be called or reverted in the simulation.

type EventContainer<'a> = <Info as SimulationInfo>::EventContainer<'a> where Self: 'a

The type of container used to access the available events.

fn data(&self) -> &Info::AccessData

Returns a reference to the data which represents the current state.

fn callables(&self) -> Info::EventContainer<'_>

Returns the events that can be called in the current state.

fn callable(&self, event: Info::Event) -> bool

Checks if the provided event can be called in the current state.

fn revertables(&self) -> Info::EventContainer<'_>

Returns the events that can be reverted in the current state.

fn revertable(&self, event: Info::Event) -> bool

Checks if the provided event can be reverted in the current state.