API Reference

Full rustdoc for every public type in the workspace, auto-generated from the /// comments on each type, function, and module. Use this when you need to know the exact shape of a struct, the methods on a trait, or what a function returns: anything the generated reference exposes better than prose can.

Open the rustdoc →

How to navigate it

• The rustdoc index lists every crate in the workspace. Open zeroclaw-api to browse the shared trait contracts and boundary types.
• Use rustdoc’s search box, keyboard search, or All Items to find a public name. Browser find searches only the current rendered page.
• Click a trait to see its methods and known implementors.

Contract boundaries

zeroclaw-api owns shared boundary types and trait definitions. Concrete implementations live in the owning capability crate and wire through that surface’s existing construction boundary. Consumers depend on the applicable traits rather than concrete types.

The trait definitions are the source of truth for exact methods, defaults, and types. The generated rustdoc is the navigable reference built from them. Use Architecture → Overview for the curated extension families and ADR-002 for the accepted trait-driven boundary decision.

Crate index

See Architecture → Crates for a plain-English description of how the crates fit together.

Regenerating the API reference

The rustdoc ships with every doc deploy. For local builds:

cargo mdbook refs     # generates CLI + config reference + rustdoc
cargo mdbook build    # rebuilds the full book including rustdoc bridge

See Maintainers → Docs & Translations.