Expand description
Boardwalk — hypermedia server framework with reverse-tunnel federation.
See the README for an introduction.
Re-exports§
pub use crate::core::Device;pub use crate::core::DeviceConfig;pub use crate::core::DeviceError;pub use crate::core::TransitionInput;pub use crate::http::App;pub use crate::http::AppError;pub use crate::http::DeviceProxy;pub use crate::http::Scout;pub use crate::http::ScoutCtx;pub use crate::http::ServerHandle;pub use crate::server::Boardwalk;
Modules§
- caql
- CaQL — Calypso Query Language.
- core
- Core types for Boardwalk.
- events
- Event bus + multiplex WebSocket sub-protocol types.
- http
- HTTP layer for Boardwalk. Hosts the runtime (
Core) and exposes it as an axum Router that emits Siren over HTTP. - peer
- Peer client (outbound) and peer socket (inbound).
- registry
- Persistent registries for devices and peers, backed by redb.
- server
- Top-level builder for assembling a Boardwalk server.
- siren
- Siren hypermedia types.
- tunnel
- WebSocket-upgrade-then-HTTP/2 tunnel primitive.
Macros§
- transitions
- Build a
transitionmethod body that dispatches to inherent async methods. Use inside aDeviceimpl:
Attribute Macros§
- device
- transition
- Marker attribute. Recognized by
#[device]on methods. On its own (without#[device]), it’s a no-op.