Rust style guidelines define how code should look and how projects should stay consistent across files and modules. They usually cover naming conventions, module and file organization, readability rules, and the use of formatting and linting tools. This page focuses on style decisions teams can apply consistently, not on language semantics or other advanced programming concerns.
Rust Code Style Guidelines
Learn practical Rust style conventions for naming, organization, formatting, and team documentation.
Read the guideWhat Rust style guidelines cover
Core Rust style standards
Naming conventions
Use clear, descriptive names for variables and functions so intent is easy to understand. Follow Rust conventions for types and modules to keep code predictable and familiar across a codebase.
Module and file organization
Group related code into logical modules and keep file structure aligned with the project’s layout. Consistent organization helps developers find definitions quickly and understand how the codebase is arranged.
Readability and consistency
Prefer straightforward code structure, consistent indentation, and uniform spacing choices. Small, repeated style decisions add up to a codebase that is easier to scan, review, and maintain.
rustfmt and clippy
Use rustfmt to apply formatting automatically and clippy to catch style issues and suspicious patterns. Together, they help teams enforce conventions without relying only on manual review.
Document style decisions for your team
A style guide works best when it is written down and easy to find. Document naming rules, module layout preferences, and any project-specific exceptions so contributors do not have to guess. Keep the guide close to your repository workflow, review it when standards change, and make rustfmt and clippy part of the team’s regular process so style stays consistent over time.
Common questions about Rust style
Do we need a style guide if Rust has conventions already?
Yes. Rust has strong community conventions, but teams still benefit from documenting their own choices for naming, organization, and review expectations. A written guide reduces ambiguity and keeps contributors aligned.
Should rustfmt be used on every project?
In most teams, yes. rustfmt provides a consistent baseline for formatting, which saves review time and removes debates about spacing or layout. It is especially useful when multiple people contribute to the same codebase.
Is clippy a replacement for code review?
No. clippy is a helpful automated assistant, but it does not replace human review. It works best as part of a broader style process that includes documentation, shared conventions, and team judgment.
How detailed should naming rules be?
Keep them specific enough to be useful, but not so long that people stop reading them. Cover the main patterns for variables, functions, types, and modules, then add examples for anything your team commonly encounters.