statum 0.3.17

Compile-time state machine magic for Rust: Zero-boilerplate typestate patterns with automatic transition validation
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52

# statum

`statum` provides an ergonomic typestate API for Rust with compile-time transition guarantees.

This crate re-exports:
- Attribute macros: `#[state]`, `#[machine]`, `#[transition]`, `#[validators]`
- Runtime types: `statum::Error`, `statum::Result<T>`
- Builder support: `statum::bon`

## Install

```toml
[dependencies]
statum = "0.3"
```

## Minimal Example

```rust
use statum::{machine, state, transition};

#[state]
enum LightState {
    Off,
    On,
}

#[machine]
struct Light<LightState> {
    name: String,
}

#[transition]
impl Light<Off> {
    fn switch_on(self) -> Light<On> {
        self.transition()
    }
}

#[transition]
impl Light<On> {
    fn switch_off(self) -> Light<Off> {
        self.transition()
    }
}
```

## Docs

- API docs: <https://docs.rs/statum>
- Repository: <https://github.com/eboody/statum>
- Workspace README: <https://github.com/eboody/statum/blob/main/README.md>