yasm 0.5.0

A simple Rust state machine library focused on usability and visualization
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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70

# Order Processing State Machine

This is an order processing state machine that demonstrates the complete lifecycle of an e-commerce order.

## State Diagram

```mermaid
stateDiagram-v2
    [*] --> Created
    Paid --> Cancelled : Refund
    Paid --> Shipped : Ship
    Shipped --> Cancelled : Cancel
    Shipped --> Delivered : Deliver
    Created --> Cancelled : Cancel
    Created --> Paid : Pay
```

## State Descriptions

- **Created**: Order has been created, waiting for payment
- **Paid**: Order has been paid, waiting for shipment
- **Shipped**: Order has been shipped, in transit
- **Delivered**: Order has been delivered, transaction complete
- **Cancelled**: Order has been cancelled

## Input Descriptions

- **Pay**: Pay for the order
- **Ship**: Ship the order
- **Deliver**: Confirm delivery
- **Cancel**: Cancel the order
- **Refund**: Request a refund

# State Transition Table

| Current State | Input | Next State |
|---------------|-------|------------|
| Created | Pay | Paid |
| Created | Cancel | Cancelled |
| Paid | Ship | Shipped |
| Paid | Refund | Cancelled |
| Shipped | Deliver | Delivered |
| Shipped | Cancel | Cancelled |

## Business Processes

### Normal Flow
1. Order created (Created)
2. User pays (Pay) → Paid
3. Merchant ships (Ship) → Shipped
4. Delivery confirmed (Deliver) → Delivered

### Cancellation Flow
- Direct cancellation after creation: Created → (Cancel) → Cancelled
- Refund after payment: Paid → (Refund) → Cancelled
- Cancellation after shipping: Shipped → (Cancel) → Cancelled

## Usage Example

```rust
use yasm::*;

let mut order = StateMachineInstance::<order::OrderStateMachine>::new();

// Normal order flow
order.transition(order::Input::Pay).unwrap();
order.transition(order::Input::Ship).unwrap();
order.transition(order::Input::Deliver).unwrap();
assert_eq!(*order.current_state(), order::State::Delivered);
```