rust

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Community Rust Best Practices

社区版Rust最佳实践

Comprehensive performance optimization guide for Rust applications. Contains 42 rules across 8 categories, prioritized by impact to guide automated refactoring and code generation.

Rust应用程序综合性能优化指南。包含8个类别下的42条规则，按影响程度排序，可指导自动化重构和代码生成。

When to Apply

适用场景

Reference these guidelines when:

Writing new Rust code
Optimizing memory allocation and ownership patterns
Working with iterators and collections
Writing async code with Tokio or other runtimes
Reviewing code for performance issues

在以下场景中参考本指南：

编写新的Rust代码
优化内存分配和所有权模式
处理迭代器和集合
使用Tokio或其他运行时编写异步代码
审查代码以排查性能问题

Rule Categories by Priority

按优先级划分的规则类别


mem-
own-
ds-
iter-
async-
algo-
comp-
micro-

Priority	Category	Impact	Prefix
1	Memory Allocation	CRITICAL	`mem-`
2	Ownership & Borrowing	CRITICAL	`own-`
3	Data Structure Selection	HIGH	`ds-`
4	Iterator & Collection Patterns	HIGH	`iter-`
5	Async & Concurrency	MEDIUM-HIGH	`async-`
6	Algorithm Complexity	MEDIUM	`algo-`
7	Compile-Time Optimization	MEDIUM	`comp-`
8	Micro-optimizations	LOW	`micro-`


mem-
own-
ds-
iter-
async-
algo-
comp-
micro-

优先级	类别	影响程度	前缀
1	内存分配	关键	`mem-`
2	所有权与借用	关键	`own-`
3	数据结构选择	高	`ds-`
4	迭代器与集合模式	高	`iter-`
5	异步与并发	中高	`async-`
6	算法复杂度	中	`algo-`
7	编译时优化	中	`comp-`
8	微优化	低	`micro-`

Quick Reference

快速参考

1. Memory Allocation (CRITICAL)

1. 内存分配（关键）

```
mem-avoid-unnecessary-clone
```
- Avoid unnecessary clone calls
```
mem-preallocate-vec-capacity
```
- Preallocate Vec capacity
```
mem-use-cow-for-conditional-ownership
```
- Use Cow for conditional ownership
```
mem-use-arc-for-shared-immutable-data
```
- Use Arc for shared immutable data

mem-avoid-format-for-simple-concatenation

- Avoid format! for simple concatenation

```
mem-use-smallvec-for-small-collections
```
- Use SmallVec for small collections

```
mem-avoid-unnecessary-clone
```
- 避免不必要的clone调用
```
mem-preallocate-vec-capacity
```
- 预分配Vec容量
```
mem-use-cow-for-conditional-ownership
```
- 使用Cow实现条件式所有权
```
mem-use-arc-for-shared-immutable-data
```
- 使用Arc处理共享不可变数据
```
mem-avoid-format-for-simple-concatenation
```
- 简单字符串拼接避免使用format!
```
mem-use-smallvec-for-small-collections
```
- 小型集合使用SmallVec

2. Ownership & Borrowing (CRITICAL)

2. 所有权与借用（关键）

```
own-accept-str-slice-not-string
```
- Accept &str instead of &String
```
own-accept-slice-not-vec
```
- Accept &[T] instead of &Vec<T>
```
own-use-into-for-flexible-ownership
```
- Use Into<T> for flexible ownership
```
own-return-borrowed-when-possible
```
- Return borrowed data when possible
```
own-use-asref-for-generic-borrows
```
- Use AsRef<T> for generic borrows

```
own-accept-str-slice-not-string
```
- 接受&str而非&String
```
own-accept-slice-not-vec
```
- 接受&[T]而非&Vec<T>
```
own-use-into-for-flexible-ownership
```
- 使用Into<T>实现灵活所有权
```
own-return-borrowed-when-possible
```
- 尽可能返回借用数据
```
own-use-asref-for-generic-borrows
```
- 使用AsRef<T>实现通用借用

3. Data Structure Selection (HIGH)

3. 数据结构选择（高）

```
ds-use-hashset-for-membership
```
- Use HashSet for membership tests
```
ds-use-hashmap-for-key-lookup
```
- Use HashMap for key-value lookups
```
ds-use-btreemap-for-sorted-iteration
```
- Use BTreeMap for sorted iteration
```
ds-use-vecdeque-for-queue-operations
```
- Use VecDeque for queue operations
```
ds-use-entry-api-for-conditional-insert
```
- Use Entry API for conditional insert

```
ds-use-hashset-for-membership
```
- 成员测试使用HashSet
```
ds-use-hashmap-for-key-lookup
```
- 键值查找使用HashMap
```
ds-use-btreemap-for-sorted-iteration
```
- 有序迭代使用BTreeMap
```
ds-use-vecdeque-for-queue-operations
```
- 队列操作使用VecDeque
```
ds-use-entry-api-for-conditional-insert
```
- 条件插入使用Entry API

4. Iterator & Collection Patterns (HIGH)

4. 迭代器与集合模式（高）

```
iter-chain-instead-of-intermediate-collect
```
- Chain iterators instead of intermediate collect
```
iter-use-iter-over-into-iter-when-borrowing
```
- Use iter() over into_iter() when borrowing

iter-use-filter-map-for-combined-operations

- Use filter_map for combined operations

```
iter-use-flat-map-for-nested-iteration
```
- Use flat_map for nested iteration
```
iter-use-extend-for-bulk-append
```
- Use extend() for bulk append
```
iter-use-fold-for-accumulation
```
- Use fold() for complex accumulation

iter-chain-instead-of-intermediate-collect

- 链式调用迭代器而非中间collect

iter-use-iter-over-into-iter-when-borrowing

- 借用时使用iter()而非into_iter()

iter-use-filter-map-for-combined-operations

- 组合操作使用filter_map

```
iter-use-flat-map-for-nested-iteration
```
- 嵌套迭代使用flat_map
```
iter-use-extend-for-bulk-append
```
- 批量追加使用extend()
```
iter-use-fold-for-accumulation
```
- 复杂累积使用fold()

5. Async & Concurrency (MEDIUM-HIGH)

5. 异步与并发（中高）

```
async-avoid-blocking-in-async-context
```
- Avoid blocking in async context
```
async-use-join-for-concurrent-futures
```
- Use join! for concurrent futures

async-use-rwlock-over-mutex-for-read-heavy

- Use RwLock over Mutex for read-heavy

```
async-minimize-lock-scope
```
- Minimize lock scope

async-use-buffered-for-bounded-concurrency

- Use buffered() for bounded concurrency

```
async-avoid-holding-lock-across-await
```
- Avoid holding lock across await

```
async-avoid-blocking-in-async-context
```
- 避免在异步上下文中阻塞
```
async-use-join-for-concurrent-futures
```
- 并发Future使用join!

async-use-rwlock-over-mutex-for-read-heavy

- 读密集场景使用RwLock而非Mutex

```
async-minimize-lock-scope
```
- 最小化锁作用域

async-use-buffered-for-bounded-concurrency

- 有界并发使用buffered()

```
async-avoid-holding-lock-across-await
```
- 避免在await期间持有锁

6. Algorithm Complexity (MEDIUM)

6. 算法复杂度（中）

```
algo-avoid-nested-loops-for-lookup
```
- Avoid nested loops for lookups
```
algo-use-binary-search-for-sorted-data
```
- Use binary search for sorted data

algo-use-sort-unstable-when-order-irrelevant

- Use sort_unstable when order irrelevant

algo-use-select-nth-unstable-for-partial-sort

- Use select_nth_unstable for partial sort

```
algo-use-chunks-for-batch-processing
```
- Use chunks() for batch processing

```
algo-avoid-nested-loops-for-lookup
```
- 查找操作避免嵌套循环
```
algo-use-binary-search-for-sorted-data
```
- 有序数据使用二分查找

algo-use-sort-unstable-when-order-irrelevant

- 无需稳定顺序时使用sort_unstable

algo-use-select-nth-unstable-for-partial-sort

- 部分排序使用select_nth_unstable

```
algo-use-chunks-for-batch-processing
```
- 批量处理使用chunks()

7. Compile-Time Optimization (MEDIUM)

7. 编译时优化（中）

comp-use-const-for-compile-time-computation

- Use const for compile-time computation

```
comp-prefer-static-dispatch
```
- Prefer static dispatch over dynamic
```
comp-reduce-monomorphization-bloat
```
- Reduce monomorphization bloat
```
comp-use-const-generics-for-array-sizes
```
- Use const generics for array sizes

comp-avoid-repeated-parsing-of-static-data

- Avoid repeated parsing of static data

comp-use-const-for-compile-time-computation

- 编译时计算使用const

```
comp-prefer-static-dispatch
```
- 优先使用静态分发而非动态分发
```
comp-reduce-monomorphization-bloat
```
- 减少单态化膨胀
```
comp-use-const-generics-for-array-sizes
```
- 数组大小使用const泛型

comp-avoid-repeated-parsing-of-static-data

- 避免重复解析静态数据

8. Micro-optimizations (LOW)

8. 微优化（低）

```
micro-use-inline-for-small-functions
```
- Apply inline attribute to small hot functions
```
micro-avoid-bounds-checks-in-hot-loops
```
- Avoid bounds checks in hot loops
```
micro-use-wrapping-arithmetic-when-safe
```
- Use wrapping arithmetic when safe
```
micro-use-byte-literals-for-ascii
```
- Use byte literals for ASCII

```
micro-use-inline-for-small-functions
```
- 小型热点函数添加inline属性
```
micro-avoid-bounds-checks-in-hot-loops
```
- 热点循环中避免边界检查
```
micro-use-wrapping-arithmetic-when-safe
```
- 安全场景使用包装算术
```
micro-use-byte-literals-for-ascii
```
- ASCII字符使用字节字面量

How to Use

使用方法

Read individual reference files for detailed explanations and code examples:

Section definitions - Category structure and impact levels
Rule template - Template for adding new rules

阅读单个参考文件获取详细说明和代码示例：

章节定义 - 类别结构与影响级别
规则模板 - 添加新规则的模板

Full Compiled Document

完整编译文档

For a comprehensive guide with all rules in a single document, see AGENTS.md.

如需包含所有规则的综合指南单文档，请查看AGENTS.md。

Reference Files

参考文件

File	Description
AGENTS.md	Complete compiled guide with all rules
references/_sections.md	Category definitions and ordering
assets/templates/_template.md	Template for new rules
metadata.json	Version and reference information

文件	描述
AGENTS.md	包含所有规则的完整编译指南
references/_sections.md	类别定义与排序
assets/templates/_template.md	新规则模板
metadata.json	版本与参考信息