StateMachineBuilder

Struct StateMachineBuilder 

Source
pub struct StateMachineBuilder<Event, State, Store> { /* private fields */ }
Expand description

StateMachineBuilder is used to build a StateMachine.

§Example

use fluent_state_machine::StateMachineBuilder;
 
let mut turnstyle = StateMachineBuilder::new((), "Locked")
    .state("Locked")
        .on("Coin").go_to("Unlocked")
    .state("Unlocked")
        .on("Push").go_to("Locked")
    .build().unwrap();

turnstyle.trigger("Coin");
assert_eq!(turnstyle.state, "Unlocked");

turnstyle.trigger("Push");
assert_eq!(turnstyle.state, "Locked");

Implementations§

Source§

impl<Event, State, Store> StateMachineBuilder<Event, State, Store>
where State: Copy + PartialEq, Event: PartialEq,

Source

pub fn new(data_store: Store, initial_state: State) -> Self

Source

pub fn set_global_action( self, global_action: fn(&mut Store, &State, &Event), ) -> Self

Source

pub const fn state(self, state: State) -> Self

Source

pub fn on(self, event: Event) -> Self

Source

pub fn go_to(self, target: State) -> Self

Source

pub fn update(self, before_event: fn(&mut Store)) -> Self

Source

pub fn only_if(self, condition: fn(&Store) -> bool) -> Self

Source

pub fn then(self, after_event: fn(&mut Store)) -> Self

Source

pub fn build( self, ) -> Result<StateMachine<Event, State, Store>, Vec<StateMachineError>>

Auto Trait Implementations§

§

impl<Event, State, Store> Freeze for StateMachineBuilder<Event, State, Store>
where State: Freeze, Store: Freeze,

§

impl<Event, State, Store> RefUnwindSafe for StateMachineBuilder<Event, State, Store>
where State: RefUnwindSafe, Store: RefUnwindSafe, Event: RefUnwindSafe,

§

impl<Event, State, Store> Send for StateMachineBuilder<Event, State, Store>
where State: Send, Store: Send, Event: Send,

§

impl<Event, State, Store> Sync for StateMachineBuilder<Event, State, Store>
where State: Sync, Store: Sync, Event: Sync,

§

impl<Event, State, Store> Unpin for StateMachineBuilder<Event, State, Store>
where State: Unpin, Store: Unpin, Event: Unpin,

§

impl<Event, State, Store> UnwindSafe for StateMachineBuilder<Event, State, Store>
where State: UnwindSafe, Store: UnwindSafe, Event: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.