Struct StateMachine

pub struct StateMachine<TCriteria, TAction> { /* private fields */ }

A compiled state machine.

The StateMachine can be created with the Builder.

Implementations

impl<TCriteria, TAction> StateMachine<TCriteria, TAction>

where TCriteria: Criteria,

pub fn start(&self) -> MachineState

Acquires the initial state of the state machine.

pub fn step( &self, current: MachineState, input: &TCriteria::Input, ) -> MachineState

Performs a step from the current machine state with the given input.

impl<TCriteria, TAction> StateMachine<TCriteria, TAction>

where TAction: Action,

pub fn execute(&self, current: MachineState, input: &mut TAction::Input)

Executes the actions of the current state with the given input.

Use Self::execute_mut if the current TAction is an ActionMut.

impl<TCriteria, TAction> StateMachine<TCriteria, TAction>

where TAction: ActionMut,

pub fn execute_mut(&mut self, current: MachineState, input: &mut TAction::Input)

Executes the actions of the current state with the given input.

Use Self::execute if the current TAction is an Action.

impl<TCriteria, TAction> StateMachine<TCriteria, TAction>

where TAction: Action, TCriteria: Criteria<Input = TAction::Input>,

pub fn step_and_execute( &self, current: MachineState, input: &mut TAction::Input, ) -> MachineState

Performs a step from the current state and executes any actions based on the new state.

This method is available only if the TCriteria and TAction have the same Input type and is equivalent to:

let next_state = machine.step(current_state, &input);
machine.execute(current_state, &mut input);

impl<TCriteria, TAction> StateMachine<TCriteria, TAction>

where TAction: ActionMut, TCriteria: Criteria<Input = TAction::Input>,

pub fn step_and_execute_mut( &mut self, current: MachineState, input: &mut TAction::Input, ) -> MachineState

Performs a step from the current state and executes any actions based on the new state.

This method is available only if the TCriteria and TAction have the same Input type and is equivalent to:

let next_state = machine.step(current_state, &input);
machine.execute_mut(current_state, &mut input);

Trait Implementations

impl<TCriteria: Debug, TAction: Debug> Debug for StateMachine<TCriteria, TAction>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.