rust-api-design - 设计符合惯例且易于演进的 Rust 库 API
依据 Rust API Guidelines 设计公共 Rust 库 API,涵盖命名、转换、trait、类型安全、易用性和未来兼容性。
标签
更新于: 2026-10-08该技能可以做什么
- 应用 Rust API Guidelines
- 选择惯用 API 命名
- 设计转换 trait
- 选择合适的派生 trait
- 设计迭代器接口
- 选择泛型与具体类型
- 创建类型安全的新类型
- 通过封闭 API 预留演进空间
- 替换布尔参数
- 避免公共 API 触发 panic
输入
- 公共 Rust crate API 目标
- 现有公共 API 定义
- 类型与 trait 设计
- 兼容性约束
输出
- Rust API 设计建议
- 命名与转换方案
- trait 与类型设计指导
- 兼容性风险说明
- Rust API 代码示例
要求
- Rust 所有权、trait 与生命周期知识
- 模块可见性与重新导出背景
- Cargo feature 配置背景
