SuperAPI AI 工具集

rust-guidelines

编程与开发

查看项目

更新于 10-16 03:17

技能介绍

用途:在编写、评审、重构、构建或部署 Rust 代码时提供规范参考,涵盖错误处理、API 设计、类型驱动设计、所有权与生命周期、智能指针、泛型与 trait 对象、文档、命名与风格、库韧性、日志、静态验证、构建部署等主题。

主要能力:错误处理上,应用层可用 anyhow/eyre,库用规范错误结构体带 Backtrace;bug 用 panic 而非 Result,库代码不应 panic!,需传播错误;避免静默失败与 bare unwrap(),用 expect("reason"),用 ? 而非 try!()。API 设计建议接受 impl AsRef、impl Read/Write,公共 API 避免 Arc/Rc/Box/RefCell,文件路径用 PathBuf/Path,3 个以上可选参数用 Builder。类型驱动设计含 Newtype、类型状态、PhantomData、标记 trait、Builder、密封 trait,避免 stringly typed、布尔参数、Option<Option<T>>。所有权部分列出 E0382、E0597、E0499 等常见错误与修法,并给出生命周期省略规则。智能指针部分给出 Box/Rc/Arc/Weak/Cell/RefCell 的决策流程与 RAII、OnceLock、LazyLock 等资源管理方式。泛型部分对比静态与动态分发,并列出对象安全条件。构建部署强调先检查 Makefile 并用其目标,注意权限与所有权、临时文件放 /tmp、测试文件位置(库内 #[cfg(test)] 或 tests/)。

使用方式:作为规范条目直接查阅;静态验证推荐在 Cargo.toml 配置 lints.rust 与 lints.clippy(如 missing_debug_implementations、unsafe_op_in_unsafe_fn、undocumented_unsafe_blocks 等)。

适用场景与限制:适合 Rust 项目开发与评审全过程;unsafe、async、性能及各领域技能另有独立条目。具体构建命令未在资料中给出。