API reference

The crate exposes a single fluent client (Client) and one per-analytic builder shape. Each builder is reached through the mode-scoped namespace (client.live(), plus the preview client.historical(start, end) and client.replay() accessors).

Entry points

Surface	Purpose
Client	The thin client. connect, live, historical, replay.
Subscription builder	Per-analytic fluent builder.
Historical builder	Preview bounded [start, end] YYYYMMDD builder shape.
Replay scope	Preview bounded replay builder shape.
*Tick / Tick*	Output schemas.
Errors	The error taxonomy (LinkError).

Generated rustdoc

The full rustdoc is generated from the workspace:

cargo doc --workspace --no-deps --locked

In production, this site embeds the rustdoc under /api/rustdoc/ once the GitHub Pages workflow is restored. Until then, treat the hand-curated reference pages as the authoritative public surface and run cargo doc locally for the full detail.