runact 1.2.0

A Rust-native actor runtime with BEAM-style processes
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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
# Runact — Architectural Document

**Project:** Runact
**Language:** Rust
**Type:** Lightweight actor/concurrency runtime
**Primary Goal:** BEAM-inspired process management with Rust ownership, safety, explicit resource lifetime, and efficient CPU-bound computation.

---

## 1. Vision

Runact is a lightweight actor runtime for Rust that provides a programming model based on:

* lightweight actors/processes
* isolated actor state
* asynchronous message passing
* bounded mailboxes
* supervision
* work-stealing scheduling
* cooperative execution
* request/reply communication
* timers
* cancellation
* resource/capability management
* dedicated CPU-compute execution
* async task execution (standard Rust `Future`s)
* observability

Async tasks are a planned execution model described in the [Async Runtime](async-runtime.md) plan. Runact will execute standard Rust `Future`s on its own executor while keeping the actor model synchronous and cooperative.

The goal is **not** to reproduce the BEAM internally.

The goal is to provide the useful process-oriented programming model of BEAM while preserving Rust's:

* ownership
* borrowing
* type safety
* deterministic destruction
* zero-cost abstractions where practical
* explicit resource management

---

## 2. Core Design Principle

The fundamental abstraction is:

> An actor owns its state and communicates with other actors through messages.

An actor should not normally share mutable state with another actor.

Conceptually:

```text
Actor A
 ├── State A
 ├── Mailbox A
 └── Behavior A

Actor B
 ├── State B
 ├── Mailbox B
 └── Behavior B

A ───── Message ─────> B
B ───── Message ─────> A
```

Ownership of data may move between actors through messages.

Shared state is an explicit design decision rather than the default.

---

## 3. Runtime Model

Runact consists of several major layers.

```text
                    ┌──────────────────────┐
                    │     Application      │
                    └──────────┬───────────┘
                               │
                    ┌──────────▼───────────┐
                    │       Actors         │
                    └──────────┬───────────┘
                               │
               ┌───────────────┼────────────────┐
               │               │                │
        ┌──────▼─────┐ ┌──────▼──────┐ ┌──────▼──────┐
        │ Mailboxes  │ │  Scheduler  │ │ Supervision │
        └────────────┘ └──────┬──────┘ └─────────────┘
                               │
                     ┌─────────▼─────────┐
                     │ Worker Threads    │
                     └─────────┬─────────┘
                               │
              ┌────────────────┴────────────────┐
              │                                 │
       ┌──────▼──────┐                  ┌──────▼──────┐
       │ Actor Work  │                  │ Compute Pool│
       └─────────────┘                  └─────────────┘
```

### Three Execution Models

Runact targets three execution models, executed cooperatively by the scheduler:

```text
                         Runact
                           │
          ┌────────────────┼────────────────┐
          │                │                │
          ▼                ▼                ▼
       Actors         Async Tasks      Compute Jobs
          │                │                │
          │                │                │
    stateful work      I/O work         CPU work
          │                │                │
          └────────────────┼────────────────┘
                           │
                       Scheduler
```

* **Actors** — long-lived stateful components processing bounded work per message.
* **Async tasks** — standard Rust `Future`s that wait on external events (I/O, timers). A pending async task consumes no worker execution time.
* **Compute jobs** — CPU-heavy work offloaded to the compute pool so it never starves actor/async execution.

Detailed design, lifecycle, cancellation, and implementation order for the async task model are specified in [Async Runtime](async-runtime.md).

---

## 4. Actor

An actor consists conceptually of:

```text
Actor
 ├── Identity
 ├── State
 ├── Mailbox
 ├── Behavior
 ├── Lifecycle
 ├── Cancellation state
 └── Runtime metadata
```

An actor must not require an operating-system thread.

Thousands or millions of actors should theoretically be multiplexed over a much smaller number of worker threads.

The actor trait is defined as:

```rust
pub trait Actor: Send + 'static {
    type Message: Send + 'static;

    fn handle(
        &mut self,
        message: Self::Message,
        context: &mut ActorContext,
    ) -> Result<(), ActorError>;
}
```

The handler is synchronous and cooperative — it must return quickly, process one message, and yield back to the scheduler.

---

## 5. Actor State

Actor state is actor-owned.

Example:

```rust
struct Counter {
    value: u64,
}
```

The actor processes messages:

```text
Increment
Get
Reset
```

Only the actor modifies:

```text
Counter.value
```

Other actors communicate with it through messages.

This provides a natural ownership boundary.

---

## 6. Actor Identity

Every actor receives a stable runtime identity.

```rust
pub struct ActorId(u64);
```

The identity allows:

* sending messages (`Runtime::send`)
* request/reply (`Runtime::request`)
* supervision (`Supervisor`)
* tracing (via `tracing` spans)
* cancellation (via `Cancellation`)
* lifecycle tracking (`ActorInfo`)
* debugging (`Runtime::inspect_actor`)

Actor IDs do not expose internal memory addresses as their public identity.

```rust
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, PartialOrd, Ord, Serialize, Deserialize)]
pub struct ActorId(u64);
```

---

## 7. Mailbox

Each actor owns a mailbox.

The mailbox is the boundary between producers and the actor.

```text
Producer
   │
   ▼
┌───────────────┐
│   Mailbox     │
│ [msg][msg][ ] │
└───────┬───────┘
        │
        ▼
     Actor
```

Runact supports bounded mailboxes. The default capacity is 1000 messages.

```text
capacity = 1000
```

The purpose of bounded mailboxes is to prevent uncontrolled memory growth.

---

## 8. Backpressure

When a mailbox is full, the sender must have an explicit policy.

Possible policies:

```text
Reject
Block
Wait asynchronously
Drop
Timeout
Return error
```

The default API prefers explicit failure rather than silently losing messages.

Example:

```rust
runtime.send(actor_id, message)?;
```

Possible error:

```rust
RuntimeError::MailboxFull(ActorId)
```

Backpressure is part of the runtime semantics. The `send` method uses `try_send` internally and returns `MailboxFull` when the bounded mailbox is at capacity. External threads may use `send_blocking` to wait until space is available.

---

## 9. Message Passing

Messages are typed.

Example:

```rust
enum Message {
    Increment,
    Reset,
    Get,
}
```

Messages may contain owned data.

Example:

```rust
struct ProcessFile {
    path: PathBuf,
    contents: Vec<u8>,
}
```

Ownership can move into the actor.

This avoids requiring shared mutable memory.

---

## 10. Rust Ownership Model

Runact embraces Rust ownership instead of trying to hide it.

Preferred model:

```text
Producer owns data
       │
       │ move
       ▼
Message owns data
       │
       │ move
       ▼
Actor owns data
```

Instead of:

```text
Arc<Mutex<T>>
```

for every piece of state.

Shared state remains possible when genuinely required.

Runact does not artificially prevent:

```rust
Arc<T>
Arc<Mutex<T>>
RwLock<T>
Atomic<T>
```

but they are not the fundamental programming model.

---

## 11. Scheduler

The scheduler is responsible for executing runnable actors.

```text
Worker 1
 ├── Actor A
 ├── Actor D
 └── Actor F

Worker 2
 ├── Actor B
 └── Actor E

Worker 3
 ├── Actor C
 └── Actor G
```

Actors are not permanently assigned to a worker.

The scheduler uses a BEAM-style design with one run queue per worker thread.

```rust
pub struct Scheduler {
    queues: Vec<RunQueue>,
    next_worker: AtomicUsize,
    handles: Vec<JoinHandle<()>>,
    stop: Arc<AtomicBool>,
}
```

---

## 12. Work Stealing

Runact uses work stealing to balance load across workers.

```text
Worker A
Queue:
[A1][A2][A3][A4]

Worker B
Queue:
[B1]

Worker B becomes idle

        │ steal
        ▼

Worker B
Queue:
[A4][A3]
```

When a worker's local queue is empty, it steals half of the tasks from a victim queue. This allows workers to balance uneven workloads.

```rust
pub(crate) fn steal_half(&self) -> Vec<Box<dyn FnOnce() + Send>> {
    let mut queue = self.queue.lock().unwrap();
    let len = queue.len();
    if len <= 1 {
        return Vec::new();
    }
    let steal_count = len / 2;
    queue.drain(..steal_count).collect()
}
```

---

## 13. Cooperative Scheduling

Actor execution is cooperative.

An actor receives a limited amount of execution budget measured in reductions.

```text
Actor A
   │
   ├── message 1
   ├── message 2
   ├── message 3
   ├── message 4
   │
   └── yield
```

This prevents one actor from monopolizing a worker.

Runact uses a reduction/budget mechanism inspired by BEAM. The default is 4000 reductions before yielding:

```rust
pub const MAX_REDUCTIONS: u64 = 4000;
```

The exact reduction accounting is an implementation detail.

---

## 14. Important Scheduling Rule

Runact distinguishes between two kinds of work:

### Short actor work

Examples:

* update state
* process command
* update cache
* route message
* emit event

### Long CPU work

Examples:

* compilation
* compression
* image processing
* cryptography
* indexing
* AI inference
* large mathematical computation

Long CPU work must not block an actor worker. It is offloaded to the compute pool.

### Async work

Examples:

* WebSocket messages
* HTTP requests
* network/filesystem I/O
* process I/O
* timers
* LSP communication

Async work waits on external events instead of consuming CPU. It is executed as standard Rust `Future`s on the Runact executor (planned — see [Async Runtime](async-runtime.md)). A pending async task must not occupy a worker; when its waker fires, the task is re-enqueued and polled again.

---

## 15. Compute Pool

Runact provides a dedicated compute pool for CPU-intensive work.

```text
Actor
  │
  │ submit job
  ▼
Compute Pool
 ├── CPU Worker 1
 ├── CPU Worker 2
 ├── CPU Worker 3
 └── CPU Worker 4
```

The actor can submit a `ComputeJob` and receive the result later:

```rust
ctx.spawn_compute(move || expensive_calculation())?;
```

Example flow:

```text
Actor
  │
  ├── submit computation
  │
  └── continue processing messages

Compute Worker
  │
  └── performs expensive calculation

Result
  │
  ▼

Actor
```

This is critical for long-running workloads.

---

## 16. Actor Must Not Block on Compute

Avoid:

```text
Actor
  │
  ├── start expensive calculation
  │
  ├── WAIT
  │
  └── cannot process messages
```

Prefer:

```text
Actor
  │
  ├── submit calculation
  │
  ├── continue processing messages
  │
  ├── process other messages
  │
  └── receive calculation result
```

This preserves actor responsiveness.

The `ComputeHandle` provides polling methods:

```rust
pub fn try_recv(&self) -> Option<Result<T, ComputeError>>;
pub fn recv(self) -> Result<T, ComputeError>;
pub fn recv_timeout(self, timeout: Duration) -> Result<T, ComputeError>;
pub fn cancel(&self);
```

---

## 17. Request / Reply

Runact supports request/reply.

```text
Actor A
   │
   │ Request
   ▼
Actor B
   │
   │ Reply
   ▼
Actor A
```

The reply mechanism does not require blocking an OS thread.

Implementation:

```text
Request
 ├── request id
 ├── payload
 └── reply channel
```

A bounded result channel (capacity 1) is used. The actor calls `ctx.reply()` to send the reply back.

```rust
pub struct RequestHandle {
    id: u64,
    receiver: crossbeam_channel::Receiver<Box<dyn std::any::Any + Send>>,
}
```

---

## 18. Deadlock Prevention

Synchronous request chains can create deadlocks.

```text
A waits for B
B waits for C
C waits for A
```

Therefore:

* asynchronous messaging is the primary model (`send`)
* synchronous `request` is implemented through asynchronous messaging with a reply channel — the actor never blocks a worker
* timeout support exists (`recv_timeout`)
* cancellation exists (`ComputeHandle::cancel`)

The fundamental invariant:

> **An actor must never synchronously wait for another actor while occupying a Runact scheduler worker.**

---

## 19. Cancellation

Operations support cancellation where practical.

```text
Task
 │
 ├── Running
 │
 ├── CancelRequested
 │
 ├── Completed
 │
 └── Cancelled
```

Cancellation distinguishes between:

```text
cooperative cancellation
```

and:

```text
forced termination
```

Rust code executing arbitrary CPU instructions cannot safely be forcibly interrupted at an arbitrary instruction boundary.

Therefore long-running compute jobs cooperate with cancellation via a flag that is checked before and after execution:

```rust
pub fn cancel(&self) {
    self.cancelled.store(true, Ordering::Relaxed);
}
```

---

## 20. Timeouts

Request/reply and asynchronous jobs support timeouts.

```rust
let reply = handle.recv_timeout(Duration::from_secs(5))?;
```

Timeouts result in explicit runtime errors (`RecvTimeoutError::Timeout`).

Timeouts are particularly important for:

* remote operations
* extension calls
* compute jobs
* shutdown
* supervision
* resource acquisition

---

## 21. Panic Handling

A panic inside a compute task does not bring down the runtime.

```text
Actor
  │
  │ panic (in compute task)
  ▼
Runtime catches failure
  │
  ├── record failure
  ├── notify (via ComputeResult::Panic)
  ├── clean up actor resources
  └── actor continues
```

Compute workers catch panics at the worker boundary:

```rust
let result = std::panic::catch_unwind(std::panic::AssertUnwindSafe(|| (task.job)()));
```

Panics are surfaced as `ComputeError::WorkerPanic(msg)`.

Supervisor strategies:

```text
Restart
Stop
Escalate
```

The supervisor decides the policy.

---

## 22. Supervision

Actors can form supervision relationships.

```text
Supervisor
 ├── FileIndexer
 ├── SearchEngine
 ├── GitService
 └── LanguageServer
```

If `FileIndexer` crashes, the supervisor may restart only `FileIndexer`.

---

## 23. Supervision Tree

Runact supports hierarchical supervision with `RestartStrategy::OneForOne`.

```text
Application
│
├── UI Supervisor
│   ├── Window Manager
│   └── UI Bridge
│
├── Editor Supervisor
│   ├── Buffer
│   ├── Search
│   └── LSP
│
└── System Supervisor
    ├── File Service
    ├── Git Service
    └── Terminal
```

Supervisor configuration:

```rust
pub enum RestartStrategy {
    OneForOne {
        max_restarts: usize,
        within: Duration,
        base_backoff: Duration,
    },
}
```

---

## 24. Lifecycle

Actors have explicit lifecycle states.

```text
Created
   ↓
Starting
   ↓
Running
   ↓
Stopping
   ↓
Stopped
```

Failure:

```text
Running
   │
   └── Failed
          │
          ├── Restart
          └── Stop
```

The runtime tracks actor lifecycle via `ActorInfo` and `tracing` events.

---

## 25. Timers

Runact provides runtime timers.

```text
send message after 1 second
repeat every 5 seconds
timeout request
schedule cleanup
```

Timers integrate with the actor system. One-shot and periodic timers are supported with drift correction (reschedule based on previous scheduled time, not current time).

Timers can be scheduled from actors:

```rust
ctx.schedule_timer(Duration::from_secs(1), WakeUpMessage)?;
ctx.schedule_interval(Duration::from_secs(5), Tick)?;
```

Or from the runtime:

```rust
runtime.schedule_timer(Duration::from_secs(1), actor_id, message)?;
runtime.schedule_interval(Duration::from_secs(5), actor_id, message)?;
```

Timers can be cancelled by ID:

```rust
runtime.cancel_timer(timer_id);
ctx.cancel_timer(timer_id);
```

---

## 26. Resources

Actors can own resources.

```text
Actor owns resource
       │
       ▼
Actor stops
       │
       ▼
Resource cleanup
```

This fits Rust's deterministic `Drop` semantics.

Resources are managed through `Capability<H>` which wraps a `ResourceHandle` with its owning `ActorId`.

---

## 27. Capabilities

Capabilities represent permissions/resources.

```text
FileSystemCapability
NetworkCapability
ProcessCapability
DatabaseCapability
UiCapability
```

An actor receives only the capabilities it needs.

Example:

```text
FileIndexer
 ├── ReadFile capability
 └── DirectoryWatch capability

AI Extension
 ├── ReadFile
 ├── Process
 └── Network
```

This becomes important for untrusted extensions.

```rust
pub struct Capability<H: ResourceHandle> {
    owner: ActorId,
    handle: Arc<H>,
}
```

---

## 28. Observability

Runact exposes:

* actor lifecycle events (via `tracing`)
* mailbox metrics (`ActorInfo.mailbox_depth`)
* scheduler metrics (worker count, task counts)
* worker utilization
* compute pool utilization
* message latency (via benchmarks)
* actor execution time (via `tracing` spans)
* crashes (via `tracing::error!`)
* restarts (via supervisor backoff)
* queue saturation (via `MailboxFull` errors)
* tracing spans (`tracing::info_span!`)

Tracing is integrated without making tracing mandatory for every application.

```rust
let stats = runtime.stats();
// RuntimeStats { actor_count, request_count }
```

---

## 29. Runtime Layers

Conceptual modules:

```text
runact/
├── src/
│   ├── actor/
│   │   ├── mod.rs
│   │   ├── id.rs          # ActorId
│   │   ├── trait_def.rs   # Actor trait
│   │   ├── context.rs     # ActorContext
│   │   └── error.rs       # ActorError
│   ├── mailbox/
│   │   ├── mod.rs
│   │   └── queue.rs       # BackpressurePolicy, Mailbox, MailboxConfig
│   ├── scheduler/
│   │   ├── mod.rs
│   │   ├── reduction.rs   # ReductionCounter
│   │   ├── run_queue.rs   # RunQueue
│   │   ├── work_stealing.rs  # Scheduler
│   │   └── worker.rs      # Worker
│   ├── supervision/
│   │   ├── mod.rs
│   │   ├── child.rs       # ChildSpec, RestartPolicy
│   │   ├── strategy.rs    # RestartStrategy
│   │   ├── supervisor.rs  # Supervisor
│   │   └── supervisor_actor.rs  # SupervisorActor
│   ├── compute/
│   │   ├── mod.rs
│   │   ├── handle.rs      # ComputeHandle
│   │   ├── scheduler.rs   # ComputeScheduler, ComputeConfig
│   │   └── task.rs        # Task, TaskId, ComputeError, ComputeResult
│   ├── timer/
│   │   ├── mod.rs
│   │   ├── service.rs     # TimerService, TimerHandle, TimerId
│   │   └── types.rs       # Timer, TimerConfig
│   ├── resource/
│   │   ├── mod.rs
│   │   ├── capability.rs  # Capability
│   │   ├── handle.rs      # ResourceHandle
│   │   └── registry.rs    # ResourceRegistry
│   └── runtime.rs            # Runtime, RuntimeConfig, RuntimeStats, RequestHandle
```

### Async Runtime Layers (planned)

The async runtime adds the following conceptual modules (see [Async Runtime](async-runtime.md)):

```text
runact/
│
├── runtime
├── scheduler
├── actor
├── mailbox
├── task        # Task<T>, TaskHandle<T>, task lifecycle
├── executor    # Future executor integrated with the scheduler
├── waker       # Runact-specific Waker with atomic state machine
├── timer       # sleep()/timeout() via timer wheel or priority queue + driver
├── cancellation # CancellationToken
├── supervision
├── compute
└── io          # optional, only if native OS I/O is ever needed
```

These are conceptual boundaries. The project is a single crate.

---

## 30. API Philosophy

Prefer small APIs.

The user should be able to understand the basic model quickly.

```rust
let mut runtime = Runtime::new().unwrap();

let actor = runtime.spawn(MyActor::new()).unwrap();

runtime.send(actor, Message::Hello).unwrap();

runtime.shutdown().unwrap();
```

Advanced features remain optional:

* Supervision — optional, for fault tolerance
* Compute pool — optional, for CPU-intensive work
* Timers — optional, for scheduled messages
* Resources/Capabilities — optional, for access control
* Tracing — optional, via `tracing-subscriber`

---

## 31. What Runact Should NOT Become

Runact should not attempt to become:

* a complete operating system
* a GUI toolkit
* an editor
* a web framework
* a database
* a distributed database
* an application framework
* an HTTP framework
* a WebSocket framework
* a TLS library
* an AI framework
* a shell/terminal framework

Runact is the concurrency/runtime foundation.

PaperOS is one major application built on top of it.

---

## 32. Distribution

Distributed actors may eventually be considered.

However, distribution is not part of the initial core.

First establish reliable local semantics:

```text
actor
message
mailbox
scheduler
supervision
compute
lifecycle
ownership
```

Only then consider:

```text
remote actors
remote messaging
cluster discovery
distributed supervision
```

---

## 33. Testing Strategy

Runact has extensive deterministic tests.

Test categories:

### Actor tests

* message processing (`tests/basic.rs`)
* state transitions
* lifecycle
* actor-to-actor communication

### Mailbox tests

* capacity (`tests/basic.rs` — `test_backpressure_rejects_when_full`)
* ordering
* backpressure
* concurrent producers

### Scheduler tests

* fairness
* work stealing (`tests/scheduler.rs`)
* yielding (reduction counting)

### Supervision tests

* panic (`supervisor_actor.rs` tests)
* restart (backoff, max restarts)
* stop
* escalation (beyond max restarts)

### Compute tests

* long-running tasks (`tests/compute.rs`)
* cancellation
* result delivery
* panic isolation

### Resource tests

* cleanup
* shutdown
* failure

### Stress tests

* thousands of actors (`benches/runact_bench.rs` — 100K actors)
* millions of messages
* high contention
* mailbox saturation

---

## 34. Performance Goals

Performance is measured rather than assumed.

Important benchmarks:

```text
actor spawn
message send
message throughput
context switching
scheduler latency
mailbox latency
request/reply latency
actor memory usage
work stealing
compute submission
shutdown
```

Benchmarks are implemented with Criterion in `benches/runact_bench.rs`.

The goal is a useful balance between:

```text
latency
throughput
fairness
memory
safety
simplicity
```

---

## 35. Architectural Invariants

These are explicit project rules.

### Invariant 1

Actor state belongs to the actor.

### Invariant 2

Messages are the primary actor communication mechanism.

### Invariant 3

Actors do not correspond to OS threads.

### Invariant 4

Long CPU work does not run on normal actor workers.

### Invariant 5

Actor failure is isolated whenever possible.

### Invariant 6

Resource ownership follows Rust ownership.

### Invariant 7

Backpressure must be explicit.

### Invariant 8

Cancellation must be cooperative for arbitrary Rust computation.

### Invariant 9

Runtime semantics must remain understandable without knowing internal implementation details.

### Invariant 10

The runtime must remain useful independently of PaperOS.

### Invariant 11

Runact is not an HTTP framework.

### Invariant 12

Runact is not a WebSocket framework.

### Invariant 13

Runact is not a TLS library.

### Invariant 14

Runact is not an AI framework.

### Invariant 15

Runact is not a shell/terminal framework.

### Invariant 16

Runact executes standard Rust futures.

### Invariant 17

Actors and async tasks remain distinct concepts.

### Invariant 18

CPU-heavy work uses the compute pool.

### Invariant 19

Async I/O never blocks an actor worker.

### Invariant 20

Cancellation is cooperative.

### Invariant 21

Structured concurrency prevents orphaned tasks.

### Invariant 22

Process cancellation prevents orphaned child processes.

### Invariant 23

TCP is the lowest-level network primitive in Runact.

### Invariant 24

HTTP/WebSocket remain outside Runact.

### Invariant 25

Tokio is optional, not fundamental.

### Invariant 26

Runact must remain useful independently of PaperOS.

### Invariant 27

PaperOS-specific concepts must not enter Runact core.

---

## 36. Development Order

Recommended implementation order (v1.0.0):

```text
1. Actor abstraction
2. Actor identity
3. Mailbox
4. Basic scheduler
5. Worker threads
6. Cooperative yielding
7. Work stealing
8. Request/reply
9. Lifecycle
10. Panic isolation
11. Supervision
12. Timers
13. Cancellation
14. Compute pool
15. Capabilities/resources
16. Tracing
17. Stress testing
18. Performance optimization
```

Do not add distributed actors or a complex plugin system before the local runtime semantics are stable.

### Async Runtime (planned)

After the v1.0.0 actor core is stable, implement the async runtime in the order defined by the [Async Runtime](async-runtime.md) boundary document (its §20 implementation strategy):

```text
1. Task, TaskHandle, Executor, future polling
2. Runact waker, runnable queue, wake deduplication
3. Async task scheduler integration
4. CancellationToken, task cancellation
5. Timers: sleep(), timeout()
6. Actor → spawn async task → result message
7. Task groups (structured concurrency)
8. Compute pool separation
9. Optional runtime adapters (e.g. Tokio) only when required
```

---

## 37. Final Architectural Definition

Runact should be understood as:

> A Rust-native actor and asynchronous execution runtime that provides lightweight process-style actors, cooperative scheduling, standard Rust Future execution, structured task lifecycle, cancellation, timers, supervision, and dedicated CPU execution—while leaving application-level I/O protocols to specialized libraries.

Its most important feature is not any individual API.

Its most important feature is the programming model:

```text
State
  ↓
Actor
  ↓
Message
  ↓
Scheduler
  ↓
Actor
  ↓
Event / Result
```

with async tasks joining the same scheduler:

```text
Future
  ↓
Task
  ↓
Runact Scheduler
  ↓
poll
  ↓
Pending → waker → re-enqueue
```

Runact is the execution foundation.

PaperOS is a major consumer of that foundation.

---

## Dependencies

Minimal dependencies, each with a clear architectural reason:

```toml
[dependencies]
crossbeam-channel = "0.5"  # Mailboxes and inter-thread communication
serde = { version = "1", features = ["derive"] }  # Serialization for ActorId
tracing = "0.1"  # Observability
thiserror = "1"  # Error handling
```

**No Tokio.** Runact owns its runtime semantics.

## Source Layout

```text
runact/
├── Cargo.toml
├── README.md
├── CHANGELOG.md
├── LICENSE
├── docs/
│   ├── architecture.md
│   ├── actors.md
│   ├── actor-communication.md
│   ├── scheduler.md
│   ├── supervision.md
│   ├── runtime.md
│   ├── vision.md
│   ├── roadmap.md
│   ├── security.md
│   ├── resources.md
│   ├── extensions.md
│   ├── persistence.md
│   ├── transactions.md
│   ├── agents.md
│   ├── object-model.md
│   ├── protocol.md
│   ├── runtime-networking-plan.md  # Runtime + Networking extension plan
│   ├── adr/
│   │   ├── 0000-template.md
│   │   ├── 0001-beam-style-scheduler.md
│   │   ├── 0002-dual-scheduler-architecture.md
│   │   └── 0003-native-async-runtime.md
│   └── guides/
│       ├── getting-started.md
│       ├── supervision.md
│       ├── compute.md
│       ├── timers.md
│       └── resources.md
├── src/
│   ├── lib.rs
│   ├── actor/
│   ├── mailbox/
│   ├── scheduler/
│   ├── supervision/
│   ├── compute/
│   ├── task/           # Async task execution (v1.1.0)
│   ├── timer/
│   ├── resource/
│   └── runtime.rs
├── examples/
│   └── counter.rs
├── benches/
│   └── runact_bench.rs
└── tests/
    ├── basic.rs
    ├── compute.rs
    ├── observability.rs
    ├── resource.rs
    ├── scheduler.rs
    ├── timer.rs
    └── async_executor.rs
```

### Future Crate Architecture (planned)

When the runtime extends to networking and process management, the conceptual crate separation will be:

```text
runact/
├── runact-core/      # actors, mailbox, scheduler, supervision
├── runact-runtime/   # executor, tasks, wakers, cancellation, timers
├── runact-compute/   # CPU-heavy work pool
├── runact-net/       # TCP, reactor, readiness, sockets
└── runact-process/   # process lifecycle, stdin/stdout/stderr
```

The exact crate boundaries may change during implementation, but the conceptual separation should remain.

## See Also

- [Runtime + Networking Plan]runtime-networking-plan.md — Full design document for extending Runact with TCP networking, process runtime, cancellation, task groups, and remote AI agent support
- [Async Runtime]async-runtime.md — Architectural boundary for the async task model: Runact schedules asynchronous work, I/O libraries define it (Future execution, task lifecycle, cancellation, timers, task groups, compute)
- [ADR-0003: Native Async Runtime]adr/0003-native-async-runtime.md — Rationale for a native Future executor without a Tokio core dependency
- [Actor Communication Principles]actor-communication.md — 24 principles governing message flow, request/reply, backpressure, cancellation, and the fundamental invariant: actors must never block scheduler workers.
- [Actors]actors.md — The Actor trait, ActorId, ActorContext, ownership model, message design.
- [Scheduler]scheduler.md — BEAM-style scheduler with work stealing and reduction counting.
- [Supervision]supervision.md — Supervision trees, restart strategies, backoff configuration.
- [Runtime]runtime.md — Top-level Runtime API, RequestHandle, RuntimeConfig, RuntimeStats.
- [Getting Started Guide]guides/getting-started.md — Walk through spawning actors, sending messages, and handling replies.