Rust Development

Rust Development

This skill enforces new code or code changes to conform to proper Rust guidelines.

When to Use

Activate this skill when:

• Writing new Rust code
• Reviewing or modifying existing Rust code
• Designing Rust APIs, libraries, or applications
• Refactoring Rust codebases

Required Gates (Before Submitting Code)

All code must pass these checks:

cargo +nightly fmt              # format
cargo clippy -- -D warnings     # lint with no warnings
cargo test                      # tests pass
cargo doc --no-deps             # docs build

Code that fails clippy or is not properly formatted should not be committed. See project-and-tooling.md for required lints and rustfmt.toml config.

Reference Files

Load the relevant file when working on the matching topic:

Guidelines Sources

These guidelines are based on:

• Microsoft Rust Guidelines
• Rust API Guidelines
• The Rust Programming Language Book
• Rust community best practices

Code Review Checklist

Required

• Code passes cargo clippy -- -D warnings
• Code is formatted with cargo +nightly fmt
• Tests pass with cargo test

Naming (naming.md)

• Follows RFC 430 case conventions
• Conversions use as_/to_/into_ correctly
• No get_ prefix on simple getters
• Iterator methods follow conventions

Types (types.md)

• Uses newtypes for distinct concepts
• Avoids bool/Option parameters with unclear meaning
• Implements appropriate standard traits
• Error types implement Error + Send + Sync

Safety (safety-and-performance.md)

• Minimizes unsafe code
• Documents safety invariants
• Validates inputs at boundaries

Documentation (documentation.md)

• All public items documented
• Examples compile and demonstrate usage
• Error/panic conditions documented

Performance (safety-and-performance.md)

• Avoids unnecessary allocations
• Uses iterators appropriately
• Takes references where ownership isn't needed

Testing (project-and-tooling.md)

• Unit tests for core logic
• Integration tests for public API
• Edge cases covered