Skip to main content

Crate roboticus_api

Crate roboticus_api 

Source
Expand description

§roboticus-api

HTTP routes, WebSocket push, authentication middleware, rate limiting, dashboard serving, config runtime, cron runtime, and abuse protection for the Roboticus agent runtime.

§Key Types

  • AppState – Shared application state passed to all route handlers
  • PersonalityState – Loaded personality files (OS, firmware, identity)
  • EventBus – Tokio broadcast channel for WebSocket event push

§Modules

  • api – REST API mount point, build_router(), route modules
  • auth – API key authentication middleware layer
  • rate_limit – Global + per-IP rate limiting (sliding window)
  • dashboard – Embedded SPA serving (compile-time or filesystem)
  • ws – WebSocket upgrade and event broadcasting
  • config_runtime – Runtime config parsing, hot-reload, and apply
  • cron_runtime – Background cron task execution
  • abuse – Abuse detection and protection

Re-exports§

pub use api::AppState;
pub use api::PersonalityState;
pub use api::build_mcp_router;
pub use api::build_public_router;
pub use api::build_router;
pub use dashboard::build_dashboard_html;
pub use dashboard::dashboard_handler;
pub use ws::EventBus;
pub use ws::ws_route;
pub use ws_ticket::TicketStore;

Modules§

abuse
Abuse signal aggregation and enforcement.
api
auth
config_runtime
cron_runtime
dashboard
rate_limit
Global API rate limiting (fixed window, Clone-friendly for axum Router).
ws
ws_ticket
Short-lived, single-use tickets for WebSocket authentication.