What problem does it solve?
Enforces idiomatic Rust API design, strong error handling, comprehensive lint discipline, and safe use of unsafe code across crates to improve reliability and maintainability.
Core Features & Use Cases
- API design guidelines: ensures UpperCamelCase types, snake_case functions, and consistent trait implementations across libraries and binaries.
- Error handling discipline: promotes Result-based error handling, leverages thiserror/anyhow, and documents safety and failure modes.
- Lint and safety discipline: applies Clippy pedantic rules, forbids unsafe blocks without SAFETY notes, and enforces robust doc and testing practices.
- Documentation and structure: encourages proper rustdoc coverage, module layout, and prelude exposure for ergonomic API consumption.
- Use Case: during code reviews, refactors, or new crate design, apply these rules to ensure shippable Rust code.
Quick Start
Review a Cargo project and adjust the crate to align with Rust API Guidelines, error handling, lint expectations, and documentation standards.