Struct StepFsm 

pub struct StepFsm { /* private fields */ }

Finite state machine for a workflow step.

Transition table

From	Event	To
Pending	Started	Running
Pending	Skipped	Skipped
Running	Succeeded	Completed
Running	Failed	Failed

Examples

use ironflow_engine::fsm::{StepFsm, StepEvent};
use ironflow_store::entities::StepStatus;

let mut fsm = StepFsm::new();
fsm.apply(StepEvent::Started).unwrap();
fsm.apply(StepEvent::Succeeded).unwrap();
assert_eq!(fsm.state(), StepStatus::Completed);

Implementations

impl StepFsm

pub fn new() -> Self

Create a new FSM in Pending state.

Examples

use ironflow_engine::fsm::StepFsm;
use ironflow_store::entities::StepStatus;

let fsm = StepFsm::new();
assert_eq!(fsm.state(), StepStatus::Pending);

pub fn from_state(state: StepStatus) -> Self

Create a FSM from an existing state.

pub fn state(&self) -> StepStatus

Returns the current state.

pub fn history(&self) -> &[Transition<StepStatus, StepEvent>]

Returns the full transition history.

pub fn is_terminal(&self) -> bool

Returns true if the FSM is in a terminal state.

pub fn apply( &mut self, event: StepEvent, ) -> Result<StepStatus, TransitionError<StepStatus, StepEvent>>

Apply an event, transitioning to a new state if valid.

Errors

Returns TransitionError if the event is not allowed in the current state.

Examples

use ironflow_engine::fsm::{StepFsm, StepEvent};

let mut fsm = StepFsm::new();
assert!(fsm.apply(StepEvent::Started).is_ok());
assert!(fsm.apply(StepEvent::Started).is_err()); // can't start twice

pub fn can_apply(&self, event: StepEvent) -> bool

Check if an event would be accepted without applying it.

Trait Implementations

impl Clone for StepFsm

fn clone(&self) -> StepFsm

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StepFsm

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

Formats the value using the given formatter.

impl Default for StepFsm

fn default() -> Self

Returns the “default value” for a type.