Struct StateMachine 

pub struct StateMachine {
    pub name: String,
    pub display_name: Option<String>,
    pub description: Option<String>,
    pub initial_state: String,
    pub states: Vec<StateDef>,
    pub transitions: Vec<Transition>,
}

A state machine schema describing lifecycle states and transitions.

Schema-only: defines structure but does not execute transitions. Guards and side effects are string references resolved externally.

use ferro_projections::{StateMachine, StateDef, Transition};

let machine = StateMachine::new("order_lifecycle")
    .initial("draft")
    .state(StateDef::new("draft").display_name("Draft"))
    .state(StateDef::new("completed").display_name("Completed").final_state())
    .transition(Transition::new("draft", "complete", "completed"));

let warnings = machine.validate().unwrap();
assert!(warnings.is_empty());

Fields

name: String

Machine identifier (e.g., “order_lifecycle”).

display_name: Option<String>

Human-readable name.

description: Option<String>

Description of what this state machine models.

initial_state: String

Name of the initial state (must exist in states).

states: Vec<StateDef>

State definitions.

transitions: Vec<Transition>

Transition definitions.

Implementations

impl StateMachine

pub fn new(name: impl Into<String>) -> Self

Creates a new state machine with the given name.

pub fn display_name(self, name: impl Into<String>) -> Self

Sets the human-readable display name.

pub fn description(self, desc: impl Into<String>) -> Self

Sets the description.

pub fn initial(self, state: impl Into<String>) -> Self

Sets the initial state name.

pub fn state(self, state: StateDef) -> Self

Adds a state definition.

pub fn transition(self, transition: Transition) -> Self

Adds a transition definition.

pub fn validate(&self) -> Result<Vec<Warning>, Error>

Validates structural integrity and returns warnings for potential issues.

Returns Err for fatal issues (missing initial state, invalid references). Returns Ok(warnings) for structural concerns (unreachable states, dead-ends).

pub fn states_for_event(&self, event: &str) -> Vec<&Transition>

Returns all transitions triggered by a given event.

pub fn events_from_state(&self, state: &str) -> Vec<&Transition>

Returns outgoing transitions from a state.

Trait Implementations

impl Clone for StateMachine

fn clone(&self) -> StateMachine

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StateMachine

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StateMachine

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for StateMachine

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for StateMachine

fn eq(&self, other: &StateMachine) -> 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.

impl Serialize for StateMachine

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for StateMachine