Skip to content
rust-template

API Documentation

The complete API documentation is generated by rustdoc and embedded at /rust-template/api/.

Viewing the API Docs

Section titled “Viewing the API Docs”

The API documentation is automatically built from doc comments in the source code using cargo doc --no-deps --all-features.

Key Types

Section titled “Key Types”
  • Error - Crate error enum derived with thiserror
  • Result<T> - Type alias for std::result::Result<T, Error>
  • Config - Configuration builder with consuming-self pattern

Building Locally

Section titled “Building Locally”
Terminal window
cargo doc --no-deps --all-features --open

This will build and open the API docs in your browser.