runact 1.1.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
# Runact Object Model

## Overview

This document defines the core runtime objects in Runact. These objects form the public API surface. Implementation details do not leak through these types.

## Core Identifiers

### ActorId

Stable, unique identifier for an actor.

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

- Created at spawn time
- Never reused within a runtime instance
- Serializable for persistence (via `serde`)
- Orderable for debugging
- Display format: `Actor(42)`

### RequestHandle

Handle to a pending request. Receives the reply asynchronously.

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

Methods:

- `id()` — Get the request's correlation ID
- `recv()` — Block until reply arrives
- `try_recv()` — Return immediately — `Ok` or `Err`
- `recv_timeout(dur)` — Block up to `dur`, then return error

---

## Actor

### Actor Trait

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

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

### ActorContext

```rust
pub struct ActorContext {
    actor_id: ActorId,
    _sender: crossbeam_channel::Sender<MessageEnvelope>,
    senders: Option<SenderMap>,
    reply_sender: Option<ReplySender>,
    compute_sender: Option<crossbeam_channel::Sender<Task>>,
    timer_handle: Option<TimerHandle>,
}
```

Methods:

- `actor_id()` — Returns the actor's own `ActorId`
- `send_to(target, msg)` — Send a fire-and-forget message to another actor
- `reply(msg)` — Reply to the sender of a request (no-op for fire-and-forget)
- `is_request()` — Check if the current message was sent as a request
- `spawn_compute(job)` — Submit a CPU-intensive task to the compute pool
- `schedule_timer(dur, msg)` — Schedule a one-shot timer
- `schedule_interval(interval, msg)` — Schedule a periodic timer
- `cancel_timer(timer_id)` — Cancel a previously scheduled timer

### ActorError

```rust
pub enum ActorError {
    Handler(String),
    Cancelled,
    Timeout,
    Panic(String),
}
```

---

## ActorInfo

Public view of a spawned actor.

```rust
pub struct ActorInfo {
    pub id: ActorId,
    pub name: Option<String>,
    pub mailbox_depth: usize,
}
```

---

## MessageEnvelope

Internal envelope wrapping messages sent to actors. Contains either a regular message or a request with a reply channel.

```rust
pub(crate) enum MessageEnvelope {
    Message(Box<dyn std::any::Any + Send>),
    Request {
        _request_id: u64,
        payload: Box<dyn std::any::Any + Send>,
        reply_sender: crossbeam_channel::Sender<Box<dyn std::any::Any + Send>>,
    },
}
```

---

## Mailbox

### BackpressurePolicy (Internal)

```rust
pub(crate) enum BackpressurePolicy {
    Reject,
    Block,
    DropLowPriority,
}
```

### MailboxConfig (Internal)

```rust
pub(crate) struct MailboxConfig {
    pub capacity: usize,
    pub backpressure: BackpressurePolicy,
}
```

Default: `capacity = 1000`, `backpressure = Reject`

---

## Scheduler

### Scheduler

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

### RunQueue

```rust
pub struct RunQueue {
    queue: Arc<Mutex<VecDeque<Task>>>,
}
```

### ReductionCounter

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

pub struct ReductionCounter {
    count: AtomicU64,
}
```

---

## Compute Scheduler

### ComputeConfig

```rust
pub struct ComputeConfig {
    pub max_workers: usize,
    pub queue_capacity: usize,
    pub task_timeout: Option<Duration>,
}
```

### ComputeScheduler

```rust
pub struct ComputeScheduler {
    sender: Option<crossbeam_channel::Sender<Task>>,
    handles: Vec<JoinHandle<()>>,
    _config: ComputeConfig,
    stop: Arc<AtomicBool>,
}
```

### ComputeHandle

```rust
pub struct ComputeHandle<T> {
    receiver: crossbeam_channel::Receiver<ComputeResult>,
    cancelled: Arc<AtomicBool>,
    _phantom: PhantomData<T>,
}
```

Methods:

- `cancel()` — Request cancellation
- `is_cancelled()` — Check if cancellation was requested
- `try_recv()` — Non-blocking poll
- `recv()` — Block until result arrives
- `recv_timeout(dur)` — Block up to timeout

### ComputeError

```rust
pub enum ComputeError {
    QueueFull,
    SchedulerShutdown,
    WorkerPanic(String),
}
```

### ComputeResult

```rust
pub enum ComputeResult {
    Ok(Box<dyn Any + Send>),
    Err(ComputeError),
    Panic(String),
    Timeout,
    Cancelled,
}
```

---

## Timer

### TimerId

```rust
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct TimerId(u64);
```

### TimerHandle

```rust
pub struct TimerHandle {
    timers: Arc<Mutex<Vec<TimerEntry>>>,
}
```

Methods:

- `schedule_timer(dur, actor_id, msg)` — One-shot timer
- `schedule_interval(interval, actor_id, msg)` — Periodic timer
- `cancel_timer(timer_id)` — Cancel a timer

### TimerConfig

```rust
pub struct TimerConfig {
    pub id: TimerId,
    pub actor_id: ActorId,
    pub scheduled_at: Instant,
    pub message: Box<dyn Any + Send>,
    pub interval: Option<Duration>,
}
```

### Timer

```rust
pub struct Timer {
    id: TimerId,
    actor_id: ActorId,
    scheduled_at: Instant,
    _message: Box<dyn Any + Send>,
    interval: Option<Duration>,
}
```

---

## Resource

### ResourceHandle

```rust
pub trait ResourceHandle: Any + Send + Sync + fmt::Debug + 'static {
    fn resource_type(&self) -> &str;
    fn as_any(&self) -> &dyn Any;
}
```

### Capability

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

Methods:

- `new(owner, handle)` — Create a new capability
- `owner()` — Returns the owning `ActorId`
- `handle()` — Borrows the underlying resource handle
- `into_handle()` — Consumes and returns the shared handle

### ResourceRegistry

```rust
pub struct ResourceRegistry {
    resources: RwLock<HashMap<TypeId, Box<dyn Any + Send + Sync>>>,
}
```

Methods:

- `new()` — Create empty registry
- `register(cap)` — Register a capability
- `get()` — Retrieve by type
- `remove()` — Remove and return by type
- `has()` — Check existence by type

---

## Runtime

### RuntimeConfig

```rust
pub struct RuntimeConfig {
    pub compute: ComputeConfig,
    pub mailbox_capacity: usize,    // Default: 1000
    pub shutdown_timeout: Duration, // Default: 5 seconds
}
```

### RuntimeStats

```rust
pub struct RuntimeStats {
    pub actor_count: usize,
    pub request_count: u64,
}
```

### RuntimeError

```rust
pub enum RuntimeError {
    ActorNotFound(ActorId),
    MailboxFull(ActorId),
    ActorExists(ActorId),
    ShutdownTimeout,
    RuntimeStopped,
}
```

---

## Supervision

### RestartStrategy

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

### ChildSpec

```rust
pub struct ChildSpec {
    pub name: String,
    pub restart_policy: RestartPolicy,
    pub shutdown_timeout: Duration,
}
```

### RestartPolicy

```rust
pub enum RestartPolicy {
    Permanent,   // Always restart
    Temporary,   // Never restart
    Transient,   // Restart only on abnormal exit
}
```

---

## Design Principles

1. **No leaked types** — `crossbeam-channel`, `serde`, and `thiserror` types do not appear in public APIs. Internal types are `pub(crate)`.
2. **Stable IDs** — `ActorId` and `TimerId` are stable within a runtime instance and never reused.
3. **Explicit errors** — All fallible operations return typed errors (`RuntimeError`, `ActorError`, `ComputeError`).
4. **Ownership transfer** — Messages transfer ownership; no shared mutable state by default.
5. **Type safety** — Capabilities are generic over `ResourceHandle`, ensuring compile-time type safety.