FSM

Struct FSM 

Source
pub struct FSM<'a, S, I, F: Action<S, I>> { /* private fields */ }
Expand description

FSM represents a finite state machine.

The FSM is initialized with an initial state and a list of events.

Implementations§

Source§

impl<'a, S, I, F> FSM<'a, S, I, F>
where S: FSMState, I: IntoIterator, F: Action<S, I>,

Source

pub fn new<T>( initial: S, events: impl IntoIterator<Item = EventDesc<T, S>>, hooks: impl IntoIterator<Item = (HookType<T, S>, F)>, ) -> Self
where T: AsRef<str>,

new creates a new FSM.

Source

pub fn get_current(&self) -> S

get_current returns the current state of the FSM.

Source

pub fn on_event<T: AsRef<str>>( &mut self, event: T, args: Option<&I>, ) -> Result<(), FSMError<String>>

on_event initiates a state transition with the named event.

Source

pub fn is<T: AsRef<S>>(&self, state: T) -> bool

is returns true if state is the current state.

Source

pub fn can<T: AsRef<str>>(&self, event: T) -> bool

can returns true if event can occur in the current state.

Trait Implementations§

Source§

impl<'a, S: Clone, I: Clone, F: Clone + Action<S, I>> Clone for FSM<'a, S, I, F>

Source§

fn clone(&self) -> FSM<'a, S, I, F>

Returns a duplicate of the value. Read more
1.0.0§

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

Performs copy-assignment from source. Read more
Source§

impl<'a, S: Debug, I: Debug, F: Debug + Action<S, I>> Debug for FSM<'a, S, I, F>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a, S, I, F> Freeze for FSM<'a, S, I, F>
where S: Freeze,

§

impl<'a, S, I, F> RefUnwindSafe for FSM<'a, S, I, F>

§

impl<'a, S, I, F> Send for FSM<'a, S, I, F>
where S: Send, I: Send, F: Send,

§

impl<'a, S, I, F> Sync for FSM<'a, S, I, F>
where S: Sync, I: Sync, F: Sync,

§

impl<'a, S, I, F> Unpin for FSM<'a, S, I, F>
where S: Unpin, I: Unpin, F: Unpin,

§

impl<'a, S, I, F> UnwindSafe for FSM<'a, S, I, F>
where S: UnwindSafe, I: UnwindSafe, F: UnwindSafe,

Blanket Implementations§

§

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

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

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

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

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

§

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

Mutably borrows from an owned value. Read more
§

impl<T> CloneToUninit for T
where T: Clone,

§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

§

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

§

fn into(self) -> U

Calls U::from(self).

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

§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
§

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

§

type Error = Infallible

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

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

Performs the conversion.
§

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

§

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

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

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

Performs the conversion.