Trait sfsm::Transition

pub trait Transition<DestinationState>: Into<DestinationState> {
    pub fn guard(&self) -> bool;

    pub fn entry(&mut self) { ... }
    pub fn execute(&mut self) { ... }
    pub fn exit(&mut self) { ... }
}

Trait that must be implemented by a state that want to transition to DestinationState.

All states can have none or many transitions. Both the entry and exit function will only be executed once for each state. The execute function will be executed as long as the state does not transition into another state. On top of the transition trait the state must implement the Into trait to specify what happens with the source state data while transitioning and how the destination state is generated. The only non optional function is the guard function that specifies when the state transitions. Note: All transition behavior is always executed after the state trait behavior.

Required methods

pub fn guard(&self) -> bool

Specifies when the state has to transit. As long as the guard returns false, the state stays in the current state. When true is returned, the state machine will transit to DestinationState

Loading content...

Provided methods

pub fn entry(&mut self)

Implement any behavior that hast to be executed when entering the state.

pub fn execute(&mut self)

Implement any behavior that has to be executed when the state is being executed. This function will be called as long as the state does not transit.

pub fn exit(&mut self)

Implement any behavior that hast to be executed when exiting the state.

Loading content...

Implementors

Loading content...