Struct StateMachineBuilder

Source

pub struct StateMachineBuilder<S, E>where
    S: Copy + Eq + Hash + Debug,
    E: Copy + Eq + Hash + Debug,
{ /* private fields */ }

Expand description

Builder used to define and validate finite state machine rules.

S is the state type and E is the event type. Configuration methods consume and return the builder so rule definitions can be chained. The built StateMachine is immutable.

Implementations§

Source §

impl<S, E> StateMachineBuilder<S, E>
where S: Copy + Eq + Hash + Debug + 'static, E: Copy + Eq + Hash + Debug + 'static,

Source

pub fn new() -> Self

Creates an empty state machine builder.

§Returns

A builder with no states or transitions.

Source

pub fn add_state(self, state: S) -> Self

Adds a state to the state machine definition.

§Parameters

state: State to register.

§Returns

The updated builder.

Source

pub fn add_states(self, states: &[S]) -> Self

Adds multiple states to the state machine definition.

§Parameters

states: States to register.

§Returns

The updated builder.

Source

pub fn set_initial_state(self, state: S) -> Self

Marks a state as an initial state.

The state must also be registered through add_state or add_states before build is called.

§Parameters

state: Initial state to add.

§Returns

The updated builder.

Source

pub fn set_initial_states(self, states: &[S]) -> Self

Marks multiple states as initial states.

§Parameters

states: Initial states to add.

§Returns

The updated builder.

Source

pub fn set_final_state(self, state: S) -> Self

Marks a state as a final state.

The state must also be registered through add_state or add_states before build is called.

§Parameters

state: Final state to add.

§Returns

The updated builder.

Source

pub fn set_final_states(self, states: &[S]) -> Self

Marks multiple states as final states.

§Parameters

states: Final states to add.

§Returns

The updated builder.

Source

pub fn add_transition(self, source: S, event: E, target: S) -> Self

Adds a transition by source state, event, and target state.

Source and target states must be registered before build is called. Adding the same transition more than once is allowed. Adding the same (source, event) with a different target is rejected during build.

§Parameters

source: State before the event is applied.
event: Event that triggers the transition.
target: State after the transition succeeds.

§Returns

The updated builder.

Source

pub fn add_transition_value(self, transition: Transition<S, E>) -> Self

Adds a transition value.

§Parameters

transition: Transition to add to the state machine definition.

§Returns

The updated builder.

Source

pub fn build(self) -> Result<StateMachine<S, E>, StateMachineBuildError<S, E>>

Builds an immutable state machine after validating the rule set.

§Returns

A validated immutable state machine.

§Errors

Returns a StateMachineBuildError when an initial state, final state, transition source, or transition target is not registered, or when two transitions map the same (source, event) pair to different targets.