API Reference

Technical reference documentation for Ralph's crates.

Crate Overview

Quick Links

Core Types

// Events
use ralph_proto::{Event, Topic, EventBus};

// Hats
use ralph_proto::{Hat, HatId};

// Configuration
use ralph_core::config::{Config, EventLoopConfig, CliConfig};

Common Operations

// Load configuration
let config = Config::load("ralph.yml")?;

// Create event loop
let event_loop = EventLoop::new(config);

// Run orchestration
event_loop.run().await?;

Rust Documentation

Generate and view Rust docs:

# Generate docs
cargo doc --no-deps --open

# Generate with dependencies
cargo doc --open

Stability

"Stable" means the public API is unlikely to change in breaking ways. "Experimental" means the API may change. "Internal" means the crate is not intended for external use.