Struct StateMachine

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

A convenience wrapper around the StateMachine trait that encapsulates the state and transition and output function calls.

Implementations

impl<T> StateMachine<T>

where T: StateMachineImpl,

pub fn new() -> Self

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

pub fn from_state(state: T::State) -> Self

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

pub fn consume( &mut self, input: &T::Input, ) -> Result<Option<T::Output>, TransitionImpossibleError>

Consumes the provided input, gives an output and performs a state transition. If a state transition with the current state and the provided input is not allowed, returns an error.

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

Returns the current state.

Trait Implementations

impl<T: Clone + StateMachineImpl> Clone for StateMachine<T>

where T::State: Clone,

fn clone(&self) -> StateMachine<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug + StateMachineImpl> Debug for StateMachine<T>

where T::State: Debug,

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

Formats the value using the given formatter.

impl<T> Default for StateMachine<T>

where T: StateMachineImpl,

fn default() -> Self

Returns the “default value” for a type.