Struct State

pub struct State<S> {
    pub data: S,
    /* private fields */
}

Wrapper struct for a state S. Use in combination with StateTransition.

Fields

data: S

Implementations

impl<S> State<S>

pub fn new(data: S) -> State<S>

where S: InitialState,

Construct the initial state of a state machine.

pub fn release_data(self) -> (Transition<S>, S)

Releases the captured state data S and provides a transition instance to perform a compile time checked state transition. Use this function when the state data S is shared between multiple states.

pub fn transition_to<T>(self, new_state: T) -> State<T>

where S: StateTransition<T>,

pub fn apply<T, E>(self, transition: T) -> E

where T: MultiTransition<E, S>,

Trait Implementations

impl<S: Debug> Debug for State<S>

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

Formats the value using the given formatter.

impl<S> Deref for State<S>

type Target = S

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<S> DerefMut for State<S>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<S: PartialEq> PartialEq for State<S>

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.