Struct StateMachine

pub struct StateMachine<T: StateMachineImpl> { /* private fields */ }

Encapsulates the state and other SM data and expose transition functions.

Implementations

impl<T> StateMachine<T>

where T: StateMachineImpl,

pub fn new(data: T, initial_state: T::InitialState) -> Self

Create a new instance of this wrapper which encapsulates the initial state.

pub fn step(&mut self)

Only change the state, do not accept any input and do not produce any output.

pub fn produce<O: From<T::Output>>(&mut self) -> O

Produce an output, given no input.

pub fn consume<I: Into<T::Input>>(&mut self, input: I)

Consume an input, do not care about the output.

pub fn relay<I: Into<T::Input>, O: From<T::Output>>(&mut self, input: I) -> O

Consume an input, produce an output.

pub fn can_step(&mut self) -> bool

pub fn can_produce<O>(&mut self) -> bool

where O: Enumerated<T::Output>,

pub fn can_consume<I>(&mut self) -> bool

where I: Enumerated<T::Input>,

pub fn can_relay<I, O>(&mut self) -> bool

where I: Enumerated<T::Input>, O: Enumerated<T::Output>,

pub fn state(&self) -> &T::State

Returns the current state.

pub fn data(&self) -> &T