Statekit
An immutable state transition validator for applications that model workflow as data.
Purpose
Many applications model workflows such as order processing, ticketing, or document approval.
When those workflows are configuration-driven or stored as data rather than hard-coded enums and match statements, validating legal transitions becomes repetitive.
Statekit provides an immutable state-machine definition that validates whether a transition is permitted.
Why use Statekit?
Statekit is intended for applications where states are not known at compile time.
Examples include:
- workflows loaded from configuration
- user-defined business processes
- state machines stored in a database
- plugins that define additional states
Status
Current release: v0.2.0.
Statekit follows semantic versioning.
Installation
[]
= "0.2.0"
Examples
use ;
Inspecting a Machine
Machines can be inspected without exposing their internal storage.
for source in machine.sources
for state in machine.states
Iteration order is unspecified.
Invariants
- State names must not be empty or consist entirely of whitespace.
- State names must not begin or end with Unicode whitespace.
- State names are case-sensitive.
- Self-transitions are rejected.
- Cycles between distinct states are permitted.
- A machine must contain at least one transition.
Validation
try_allow() validates state names and transition relationships when they are added.
build() validates machine-level requirements, including that at least one transition exists.
Features
Error Handling
All public Statekit errors implement std::error::Error.
Immutability
Once constructed, a machine cannot be modified.
This allows a machine definition to be reused safely without callers mutating its transition structure.
What it is Not
Statekit is not:
- a process engine
- a policy engine
- pathfinding code
- workflow engine
Statekit can be used as a building block for these kinds of systems, but intentionally does not implement them.
Documentation
- Statekit Specification — domain definitions and invariants
- Migration Guide — guidance for upgrading between releases
- Changelog — notable changes by release
License
MIT