# Maiko
<div align="center">
**Lightweight actor framework for Tokio**
[](https://crates.io/crates/maiko)
[](https://docs.rs/maiko)
[](LICENSE)
</div>
---
## What is Maiko?
**Maiko** is an [actor framework](https://en.wikipedia.org/wiki/Actor_model) for Tokio. Structure your application as independent components (actors) - each with its own state, logic, and lifecycle - communicating purely through events.
Each actor:
- Runs in its own async task
- Maintains private state (no shared memory, no locks)
- Receives events through a dedicated channel
- Publishes events without knowing who receives them
Actors subscribe to topics, publish events, and Maiko routes automatically. Publishers don't need to know who's listening - think Kafka-style pub/sub, but for Tokio tasks instead of distributed systems.
### No more channel spaghetti
Building concurrent Tokio applications often means manually creating, cloning, and wiring channels between tasks:
```rust
// Without Maiko: manual channel wiring
let (tx1, rx1) = mpsc::channel(32);
let (tx2, rx2) = mpsc::channel(32);
let (tx3, rx3) = mpsc::channel(32);
// Clone tx1 for task B, clone tx2 for task C, wire rx1 to...
```
```rust
// With Maiko: declare subscriptions, routing happens automatically
sup.add_actor("sensor", |ctx| Sensor::new(ctx), Subscribe::none())?; // produces events
sup.add_actor("processor", |ctx| Processor::new(ctx), &[Topic::SensorData])?; // handles sensor data
sup.add_actor("logger", |ctx| Logger::new(ctx), Subscribe::all())?; // observes everything
```
### How it compares
| Routing | Topic-based pub/sub | Direct addressing | Topic-based pub/sub |
| Coupling | Loose (actors don't know each other) | Tight (need actor addresses) | Loose |
| Communication | Events | Request-response | Events |
| Scope | In-process | In-process | Distributed |
### Where it fits
Event-centric systems: processing stock ticks, device signals, telemetry pipelines, handling system
events, data transformation.
Not ideal for request-response APIs or RPC patterns.
---
## Quick Start
```sh
cargo add maiko
```
```rust
use maiko::*;
#[derive(Event, Clone, Debug)]
enum MyEvent {
Hello(String),
}
struct Greeter;
impl Actor for Greeter {
type Event = MyEvent;
async fn handle_event(&mut self, envelope: &Envelope<Self::Event>) -> Result<()> {
if let MyEvent::Hello(name) = envelope.event() {
println!("Hello, {}!", name);
}
Ok(())
}
}
#[tokio::main]
async fn main() -> Result<()> {
let mut sup = Supervisor::<MyEvent>::default();
sup.add_actor("greeter", |_ctx| Greeter, &[DefaultTopic])?;
sup.start().await?;
sup.send(MyEvent::Hello("World".into())).await?;
sup.stop().await
}
```
### Examples
See the [`examples/`](maiko/examples/) directory:
- **[`pingpong.rs`](maiko/examples/pingpong.rs)** - Event exchange between actors
- **[`guesser.rs`](maiko/examples/guesser.rs)** - Multi-actor game with topics and timing
- **[`monitoring.rs`](maiko/examples/monitoring.rs)** - Observing event flow
```bash
cargo run --example pingpong
cargo run --example guesser
```
---
## Core Concepts
| **Event** | Messages that flow through the system (`#[derive(Event)]`) |
| **Topic** | Routes events to interested actors |
| **Actor** | Processes events via `handle_event()` and produces events via `step()` |
| **Context** | Provides actors with `send()`, `stop()`, and metadata access |
| **Supervisor** | Manages actor lifecycles and the runtime |
| **Envelope** | Wraps events with metadata (sender, correlation ID) |
For detailed documentation, see **[Core Concepts](docs/concepts.md)**.
---
## Test Harness
Maiko includes a test harness (built on the monitoring API) for observing and asserting on event flow:
```rust
#[tokio::test]
async fn test_event_delivery() -> Result<()> {
let mut sup = Supervisor::<MyEvent>::default();
let producer = sup.add_actor("producer", |ctx| Producer::new(ctx), &[DefaultTopic])?;
let consumer = sup.add_actor("consumer", |ctx| Consumer::new(ctx), &[DefaultTopic])?;
let mut test = Harness::new(&mut sup).await;
sup.start().await?;
test.start_recording().await;
let id = test.send_as(&producer, MyEvent::Data(42)).await?;
test.stop_recording().await;
assert!(test.event(id).was_delivered_to(&consumer));
assert_eq!(1, test.actor(&consumer).inbound_count());
sup.stop().await
}
```
Enable with `features = ["test-harness"]`. See **[Test Harness Documentation](docs/testing.md)** for details.
---
## Monitoring
The monitoring API provides hooks into the event lifecycle - useful for debugging, metrics, and logging:
```rust
use maiko::monitoring::Monitor;
struct EventLogger;
impl<E: Event, T: Topic<E>> Monitor<E, T> for EventLogger {
fn on_event_handled(&self, envelope: &Envelope<E>, topic: &T, receiver: &ActorId) {
println!("[handled] {} by {}", envelope.id(), receiver.name());
}
}
let handle = sup.monitors().add(EventLogger).await;
```
Enable with `features = ["monitoring"]`. See **[Monitoring Documentation](docs/monitoring.md)** for details.
---
## Documentation
- **[Core Concepts](docs/concepts.md)** - Events, Topics, Actors, Context, Supervisor
- **[Monitoring](docs/monitoring.md)** - Event lifecycle hooks, metrics collection
- **[Test Harness](docs/testing.md)** - Recording, spies, queries, assertions
- **[Advanced Topics](docs/advanced.md)** - Error handling, configuration, design philosophy
- **[FAQ](docs/faq.md)** - Common questions answered
- **[API Reference](https://docs.rs/maiko)** - Complete API documentation
---
## Roadmap
**Near-term:**
- Dynamic actor spawning/removal at runtime
- Improved supervision and error handling strategies
**Future:**
- `maiko-actors` crate with reusable actors (IPC bridges, WebSocket, OpenTelemetry)
- Cross-process communication via bridge actors
---
## Used In
Maiko powers the daemon in [**Charon**](https://github.com/ddrcode/charon) - a USB keyboard pass-through device built on Raspberry Pi. The daemon uses Maiko actors to read input from multiple keyboards, map and translate key events, output USB HID to the host, and coordinate telemetry, IPC, and power management.
---
## Current State
Maiko is battle-tested in the [Charon](https://github.com/ddrcode/charon) project, where it runs continuously, but it's not yet production-grade. I'd describe it as solid for happy-path scenarios and insufficient for rainy days. Supervision is minimal, backpressure isn't handled, and improved error handling and recovery strategies are planned for 0.3.0.
For now, Maiko demonstrates what it wants to be. That's the state I wanted to reach before sharing it with a wider audience. Want to help shape what comes next? See below.
---
## Contributing
Contributions welcome! Whether it's a bug report, feature idea, or pull request - all input is appreciated.
- **Try it out** and let us know what you think
- **Report issues** via [GitHub Issues](https://github.com/ddrcode/maiko/issues)
- **Looking to contribute code?** Check out [good first issues](https://github.com/ddrcode/maiko/issues?q=is%3Aissue+state%3Aopen+label%3A%22good+first+issue%22)
---
## Acknowledgments
Inspired by [Kafka](https://kafka.apache.org/) (topic-based routing) and built on [Tokio](https://tokio.rs/) (async runtime).
---
## License
Licensed under the [MIT License](LICENSE).