Building

Prerequisites

• Rust 1.92+ (2024 edition)
• wasm32-unknown-unknown target (for WASM builds)

Optional tools (provisioned by .mise.toml):

• cargo-nextest: Parallel test runner (used by CI)
• cargo-llvm-cov: Code coverage
• cargo-deny: Dependency auditing
• mdbook: Documentation site

Build Commands

# Build
cargo build                                      # Debug build
cargo build --workspace --release                # Release build

# Check
cargo check --workspace --all-targets --all-features

# Test (CI uses cargo-nextest)
cargo nextest run --workspace --all-features     # Run all tests
cargo nextest run --lib --workspace              # Run library tests only (faster)
cargo nextest run test_name                      # Run a specific test
cargo test --doc --workspace                     # Run doc tests (nextest does not support doc tests)

# Quality
cargo fmt --all                                  # Format code
cargo fmt --all -- --check                       # Check formatting
cargo clippy --workspace --all-targets --all-features  # Clippy lints
cargo doc --workspace --all-features --no-deps   # Generate documentation

QA Pipeline

After completing any coding task, run the full QA suite:

cargo fmt --all && cargo clippy --workspace --all-targets --all-features && cargo nextest run --workspace --all-features

CI runs these additional checks:

CI sets RUSTFLAGS="-D warnings" to treat warnings as errors.

Cross-Platform Builds

CI verifies compilation on 10 targets:

Documentation

Build the API documentation:

cargo doc --workspace --all-features --no-deps

Build this mdbook site:

mdbook build docs

Serve locally with auto-reload:

mdbook serve docs