Struct finny::decl::FsmBuilder

pub struct FsmBuilder<TFsm, TContext> {
    pub _fsm: PhantomData<TFsm>,
    pub _context: PhantomData<TContext>,
}

The main builder-API for defining your Finny state machine.

Fields

_fsm: PhantomData<TFsm>

_context: PhantomData<TContext>

Implementations

impl<TFsm, TContext> FsmBuilder<TFsm, TContext> where
    TFsm: FsmBackend<Context = TContext>, 

pub fn initial_state<TSTate>(&mut self)

Sets the initial state of the state machine. Required!

pub fn initial_states<TStates>(&mut self)

Defines multiple initial states for multiple regions of the FSM. The type has to be a tuple of the initial states for each region.

Example : fsm.initial_states<(StateA, StateX)>()

pub fn events_debug(&mut self)

Require the Debug trait on the Events.

pub fn state<TState>(&mut self) -> FsmStateBuilder<TFsm, TContext, TState>

Adds some information about a state.

pub fn sub_machine<TSubFsm>(
    &mut self
) -> FsmSubMachineBuilder<TFsm, TContext, TSubFsm> where
    TSubFsm: FsmBackend, 

Adds a sub machine

pub fn build(self) -> BuiltFsm

Builds the final machine. Has to be returned from the definition function.

Trait Implementations

impl<TFsm: Default, TContext: Default> Default for FsmBuilder<TFsm, TContext>

fn default() -> FsmBuilder<TFsm, TContext>

Returns the “default value” for a type.