---

name: rust-coding description: "Rust 编码规范专家。处理命名, 格式化, 注释, clippy, rustfmt, lint, 代码风格, 最佳实践, naming convention, 代码审查, P.NAM, G.FMT, 怎么命名, 代码规范" globs: ["**/*.rs"]

Rust 编码规范

核心问题

什么样的 Rust 代码才是"惯用的"？

遵循社区约定，让代码可读、可维护。

---

命名规范 (Rust 特有)

通用命名

Copy// 变量和函数：snake_case
let max_connections = 100;
fn process_data() { ... }

// 类型和 trait：CamelCase
struct UserSession;
trait Cacheable {}

// 常量：SCREAMING_SAME_CASE
const MAX_CONNECTIONS: usize = 100;
static CONFIG:once_cell::sync::Lazy<Config> = ...

---

数据类型规范

字符串

---

错误处理规范

Copy// ✅ 好的错误处理
fn read_config() -> Result<Config, ConfigError> {
    let content = std::fs::read_to_string("config.toml")
        .map_err(ConfigError::from)?;
    toml::from_str(&content)
        .map_err(ConfigError::parse)
}

// ❌ 避免
fn read_config() -> Config {
    std::fs::read_to_string("config.toml").unwrap()  // panic!
}

---

内存与生命周期

---

并发规范

---

Async 规范

---

宏规范

---

废弃模式 → 推荐

---

Clippy 规范

Copy[package]
edition = "2024"
rust-version = "1.85"

[lints.rust]
unsafe_code = "warn"

[lints.clippy]
all = "warn"
pedantic = "warn"

常用 Clippy 规则

---

格式化 (rustfmt)

Copy# 使用默认配置即可
rustfmt src/lib.rs

# 检查格式
rustfmt --check src/lib.rs

# 配置文件 .rustfmt.toml
max_line_width = 100
tab_spaces = 4
edition = "2024"

---

文档规范

Copy/// 模块文档
//! 本模块处理用户认证...

/// 结构体文档
/// 
/// # Examples
/// ```
/// let user = User::new("name");
/// ```
pub struct User { ... }

/// 方法文档
/// 
/// # Arguments
/// 
/// * `name` - 用户名
/// 
/// # Returns
/// 
/// 初始化后的用户实例
/// 
/// # Panics
/// 
/// 当用户名为空时 panic
pub fn new(name: &str) -> Self { ... }

---

快速参考

Copy命名: snake_case (fn/var), CamelCase (type), SCREAMING_CASE (const)
格式: rustfmt (just use it)
文档: /// for public items, //! for module docs
Lint: #![warn(clippy::all)]

---

代码审查清单

• 命名符合 Rust 惯例
• 使用 ? 而非 unwrap()
• 避免不必要的 clone()
• unsafe 块有 SAFETY 注释
• 公共 API 有文档注释
• 运行 cargo clippy
• 运行 cargo fmt