Rust API reference (rustdoc)
Every public item in every crate is documented. Three ways to read it:
- Live, browsable: the CI deploys
cargo docoutput alongside this book under/rustdoc/. You’re probably reading the book athttps://isaacrowntree.github.io/bezant/— jump to/rustdoc/bezant/for the facade crate. - Local:
cargo doc --workspace --no-deps --open - docs.rs (once published): will link here once the crates hit crates.io.
Per-crate entry points
bezant— ergonomic facadebezant_api— auto-generated clientbezant_spec— vendored specbezant_server— HTTP sidecar libbezant_mcp— MCP tool surface
Conventions
- Every public function has a one-line summary in the first sentence, a
longer explanation where useful, and
# Errors/# Panicssections per the Rust API Guidelines. - Examples compile as doctests (try
cargo test --workspace --doc). - Generated crates (
bezant-api) have auto-derived docs from the spec’sdescriptionfields — so the same docstrings ship to docs.rs that IBKR writes themselves.