Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

API Reference

The per-crate API documentation is generated by rustdoc from the source. Build it locally with:

cargo doc --workspace --no-deps --open

Every public type, function, and trait carries doc comments, so the generated reference is the authoritative description of each crate’s surface. Once the crates are published, the same documentation is available on docs.rs.