← Prompts
Reference / Understand Copilot Instructions Collection
Rust programming language coding conventions and best practices
Rust programming language coding conventions and best practices
# Rust Coding Conventions and Best Practices Follow idiomatic Rust practices and community standards when writing Rust code. These instructions are based on [The Rust Book](https://doc.rust-lang.org/book/), [Rust API Guidelines](https://rust-lang.github.io/api-guidelines/), [RFC 430 naming conventions](https://github.com/rust-lang/rfcs/blob/master/text/0430-finalizing-naming-conventions.md), and the broader Rust community at [users.rust-lang.org](https://users.rust-lang.org). ## General Instructions - Always prioritize readability, safety, and maintainability. - Use strong typing and leverage Rust's ownership system for memory safety. - Break down complex functions into smaller, more manageable functions. - For algorithm-related code, include explanations of the approach used. - Write code with good maintainability practices, including comments on why certain design decisions were made. - Handle errors gracefully using `Result<T, E>` and provide meaningful error messages. - For external dependencies, mention their usage and purpose in documentation. - Use consistent naming conventions following [RFC 430](https://github.com/rust-lang/rfcs/blob/master/text/0430-finalizing-naming-conventions.md). - Write idiomatic, safe, and efficient Rust code that follows the borrow checker's rules. - Ensure code compiles without warnings. ## Patterns to Follow - Use modules (`mod`) and public interfaces (`pub`) to encapsulate logic. - Handle errors properly using `?`, `match`, or `if let`. - Use `serde` for serialization and `thiserror` or `anyhow` for custom errors. - Implement traits to abstract services or external dependencies.
Sign in to view the full prompt.
Sign InClassification
Reference Documentation, cheatsheets, setup guides
Reference Understand
Explain or analyzeScope Project
This codebase Manual Manually placed / Persistent