rust-style-guide

name

rust-style-guide

description

Apply this Rust style guide when writing, reviewing, refactoring, or configuring Rust code for this project. Covers Rust 2024/MSRV, workspace architecture, library vs application conventions, public API design, errors, panics, ownership and cloning, async/Tokio/concurrency, tracing, rustfmt/Clippy, testing with nextest, and unsafe/macro policy. Also use when setting up new Rust projects, investigating performance, verifying library releases, or reviewing Rust changes.

Rust Style Guide

Apply the loaded policy pages directly.

Routing

Workflows

Task	Load
Create or configure a Rust project	new project workflow
Verify a reusable library release	library release workflow
Investigate performance	performance workflow
Review or refactor Rust code	review workflow

Policy Fast Paths

Task	Load
Define a public library error	library/application errors, error taxonomy, public API evolution
Handle top-level application errors	library/application errors, error propagation, panics
Choose enum, generic, or trait object	enum/trait selection, trait design
Add a domain ID or validated value	newtypes, constructors, validation
Write async service code	async runtime, task lifecycle, shutdown, logging
Add instrumentation	logging and observability
Configure formatting, lints, or tests	rustfmt, Clippy, CI
Review unsafe code or macros	unsafe code and macros, public API evolution
Other Rust policy work	guideline index

Core Behavior

• Workflows own multi-step procedures and route to their policy pages.
• Fast paths load only the directly linked owner pages.
• Use the guideline index only when no workflow or fast path matches.
• Select conditional pages using task descriptions in this router, the guideline index, or workflow routing.
• After loading a conditional page, apply it only when its Activation section matches.
• Prefer concrete Rust guidance over language tutorials.
• Ask one focused question only when required project context is missing.