API Reference
Pure lookup -- find the method signature you need. For explanations and tutorials, see Learn and Tutorials.
Core APIs
| API | What it covers |
|---|---|
| Scheduler API | Builder methods, execution modes, introspection |
| Topic API | send, recv, try_send, try_recv, read_latest, capacity |
| Services API | ServiceClient, ServiceServer, call, call_resilient |
| Actions API | ActionClient, ActionServer, GoalStatus, GoalOutcome |
| TransformFrame API | Frame registration, lookups, interpolation |
Helpers
| API | What it covers |
|---|---|
| DurationExt & Frequency | .hz(), .ms(), .us(), .secs(), Frequency type |
| Macros | message!, service!, action!, node!, hlog! |
| Feature Flags | telemetry, blackbox, macros |
Configuration
| Reference | What it covers |
|---|---|
| CLI Reference | All horus commands and flags |
| Error Reference | HorusError variants, error patterns |
| horus.toml | Project manifest format |
| Configuration | Global and project configuration |
Quick Lookup
| Reference | What it covers |
|---|---|
| API Cheatsheet | Every public type signature on one page |
| AI Context | Dense, machine-readable API reference for AI agents |
See Also
- API Cheatsheet — Every public type signature on one page
- AI Context — Machine-readable API context for AI coding agents
- Internals — Architecture for contributors
- Benchmarks — Latency and throughput measurements
- CLI Reference — All 46+ commands and flags