rust-guidelines

Rust guidelines provide pragmatic conventions covering idiomatic patterns, thorough documentation, strong typing, error handling, and performance optimization. They help developers and AI agents maintain consistent, high-quality code across libraries and applications while adhering to canonical standards for safety and API design.

Use canonical error struct patterns as outlined in guidelines to establish robust, predictable error handling. This ensures errors are properly typed, well-documented, and can be reliably handled by both developers and AI agents throughout your codebase.

Performance guidelines cover identifying hot paths, leveraging efficient allocators like Mimalloc in applications, and designing APIs for high throughput. These optimizations ensure your Rust project achieves maximum efficiency without sacrificing code clarity.

Documentation enables AI agents and developers to understand and correctly use your APIs. Rust guidelines require comprehensive docs to ensure AI-friendly API design, making your code more maintainable and enabling effective automated code assistance.

Use guidelines to audit new modules for documentation completeness, error handling patterns, unsafe code usage, and performance best practices. This provides immediate feedback on whether code meets quality gates and follows canonical conventions across your project.

Yes. Guidelines cover both libraries and applications, addressing documentation, strong types, testing, and performance for each context. They ensure consistent code quality standards across different project types in your Rust ecosystem.