# Technical Documentation: KaiserY/trpl-zh-cn

> ℹ️ **Provenance:** Multi-Tier Ingestion · [CodeWiki Reference](https://codewiki.google/github.com/KaiserY/trpl-zh-cn)

### Overview (`README.md`)

# Rust 程序设计语言（2024 edition）简体中文版



## 状态

- 2024 edtion 施工完毕。

PS:

- 对照源码位置：[https://github.com/rust-lang/book/tree/main/src][source]
- 注意源码 `src` 目录一般会比 [https://doc.rust-lang.org/book/](https://doc.rust-lang.org/book/) 要新，如果遇到冲突建议对照 `src` 目录。
- 每章翻译开头都带有官方链接和 commit hash 的注释，若发现与官方不一致，欢迎 Issue 或 PR

[source]: https://github.com/rust-lang/book/tree/main/src

## 校对

部分章节采用 Codex 辅助校对。提示词可参考 [proofreading_prompt.md](proofreading_prompt.md)

## 静态页面构建与文档撰写

### 构建

你可以将本 mdbook 构建成一系列静态 html 页面。这里我们采用 [mdbook](https://rust-lang.github.io/mdBook/index.html) 打包出静态网页。在这之前，你需要安装 [Rust](https://www.rust-lang.org/zh-CN/)。

全局安装 mdbook

```bash
cargo install mdbook
```

cd 到项目目录，然后开始构建。构建好的静态文档会出现在 "./book/html" 中

```bash
mdbook build
```

在本地部署 HTTP 服务器以阅读文档：

```bash
mdbook serve
```

## 社区资源

- Rust 语言中文社区：<https://rustcc.cn/>
- Rust 编程语言社区 1 群，群号：303838735（已满，只能内部邀请）
- Rust 编程语言社区 2 群，群号：813448660

## PDF

[Rust 程序设计语言 简体中文版.pdf](https://kaisery.github.io/trpl-zh-cn/Rust%20%E7%A8%8B%E5%BA%8F%E8%AE%BE%E8%AE%A1%E8%AF%AD%E8%A8%80%20%E7%AE%80%E4%BD%93%E4%B8%AD%E6%96%87%E7%89%88.pdf)

- 由 [mdbook-typst-pdf](https://github.com/KaiserY/mdbook-typst-pdf) 生成，有任何问题欢迎 issue 或 PR

## EPUB

你可以使用项目中提供的 Rust 构建工具将本书编译为 EPUB 电子书。

在此之前，请确保您的系统已安装了 [Pandoc](https://pandoc.org/)。

在项目根目录下，运行以下命令开始编译：

```bash
cargo run --release --manifest-path epub-builder/Cargo.toml
```

编译成功后，会在根目录下生成 `rust_programming_language.epub`。

## GitBook

本翻译主要采用 [mdBook](https://github.com/rust-lang-nursery/mdBook) 格式。同时支持 [GitBook](https://github.com/GitbookIO/gitbook)，但会缺失部分功能，如一些代码没有语法高亮。

本翻译加速查看站点有：

- 深圳站点：<http://120.78.128.153/rustbook>

[GitBook.com](https://www.gitbook.com/) 地址：<https://kaisery.github.io/trpl-zh-cn/>

---

### Overview (`src/README.md`)

# Rust 程序设计语言

[Rust 程序设计语言](title-page.md)
[前言](foreword.md)
[简介](ch00-00-introduction.md)

## 入门指南

- [入门指南](ch01-00-getting-started.md)
    - [安装](ch01-01-installation.md)
    - [Hello, World!](ch01-02-hello-world.md)
    - [Hello, Cargo!](ch01-03-hello-cargo.md)

- [写个猜数字游戏](ch02-00-guessing-game-tutorial.md)

- [常见编程概念](ch03-00-common-programming-concepts.md)
    - [变量与可变性](ch03-01-variables-and-mutability.md)
    - [数据类型](ch03-02-data-types.md)
    - [函数](ch03-03-how-functions-work.md)
    - [注释](ch03-04-comments.md)
    - [控制流](ch03-05-control-flow.md)

- [认识所有权](ch04-00-understanding-ownership.md)
    - [什么是所有权？](ch04-01-what-is-ownership.md)
    - [引用与借用](ch04-02-references-and-borrowing.md)
    - [Slice 类型](ch04-03-slices.md)

- [使用结构体组织相关联的数据](ch05-00-structs.md)
    - [结构体的定义和实例化](ch05-01-defining-structs.md)
    - [结构体示例程序](ch05-02-example-structs.md)
    - [方法语法](ch05-03-method-syntax.md)

- [枚举和模式匹配](ch06-00-enums.md)
    - [枚举的定义](ch06-01-defining-an-enum.md)
    - [`match` 控制流结构](ch06-02-match.md)
    - [`if let` 简洁控制流](ch06-03-if-let.md)

## 基本 Rust 技能

- [使用包、Crate 和模块管理不断增长的项目](ch07-00-managing-growing-projects-with-packages-crates-and-modules.md)
    - [包和 Crate](ch07-01-packages-and-crates.md)
    - [定义模块来控制作用域与私有性](ch07-02-defining-modules-to-control-scope-and-privacy.md)
    - [引用模块项目的路径](ch07-03-paths-for-referring-to-an-item-in-the-module-tree.md)
    - [使用 `use` 关键字将路径引入作用域](ch07-04-bringing-paths-into-scope-with-the-use-keyword.md)
    - [将模块拆分成多个文件](ch07-05-separating-modules-into-different-files.md)

- [常见集合](ch08-00-common-collections.md)
    - [使用 Vector 储存列表](ch08-01-vectors.md)
    - [使用字符串储存 UTF-8 编码的文本](ch08-02-strings.md)
    - [使用 Hash Map 储存键值对](ch08-03-hash-maps.md)

- [错误处理](ch09-00-error-handling.md)
    - [用 `panic!` 处理不可恢复的错误](ch09-01-unrecoverable-errors-with-panic.md)
    - [用 `Result` 处理可恢复的错误](ch09-02-recoverable-errors-with-result.md)
    - [要不要 `panic!`](ch09-03-to-panic-or-not-to-panic.md)

- [泛型、Trait 和生命周期](ch10-00-generics.md)
    - [泛型数据类型](ch10-01-syntax.md)
    - [Trait：定义共同行为](ch10-02-traits.md)
    - [生命周期确保引用有效](ch10-03-lifetime-syntax.md)

- [编写自动化测试](ch11-00-testing.md)
    - [如何编写测试](ch11-01-writing-tests.md)
    - [控制测试如何运行](ch11-02-running-tests.md)
    - [测试的组织结构](ch11-03-test-organization.md)

- [一个 I/O 项目：构建命令行程序](ch12-00-an-io-project.md)
    - [接受命令行参数](ch12-01-accepting-command-line-arguments.md)
    - [读取文件](ch12-02-reading-a-file.md)
    - [重构以改进模块化与错误处理](ch12-03-improving-error-handling-and-modularity.md)
    - [采用测试驱动开发完善库的功能](ch12-04-testing-the-librarys-functionality.md)
    - [处理环境变量](ch12-05-working-with-environment-variables.md)
    - [将错误信息输出到标准错误而不是标准输出](ch12-06-writing-to-stderr-instead-of-stdout.md)

## Rust 编程思想

- [Rust 中的函数式语言功能：迭代器与闭包](ch13-00-functional-features.md)
    - [闭包：可以捕获其环境的匿名函数](ch13-01-closures.md)
    - [使用迭代器处理元素序列](ch13-02-iterators.md)
    - [改进之前的 I/O 项目](ch13-03-improving-our-io-project.md)
    - [性能比较：循环对迭代器](ch13-04-performance.md)

- [更多关于 Cargo 和 Crates.io 的内容](ch14-00-more-about-cargo.md)
    - [采用发布配置自定义构建](ch14-01-release-profiles.md)
    - [将 crate 发布到 Crates.io](ch14-02-publishing-to-crates-io.md)
    - [Cargo 工作空间](ch14-03-cargo-workspaces.md)
    - [使用 `cargo install` 从 Crates.io 安装二进制文件](ch14-04-installing-binaries.md)
    - [Cargo 自定义扩展命令](ch14-05-extending-cargo.md)

- [智能指针](ch15-00-smart-pointers.md)
    - [使用 `Box<T>` 指向堆上数据](ch15-01-box.md)
    - [使用 `Deref` Trait 将智能指针当作常规引用处理](ch15-02-deref.md)
    - [使用 `Drop` Trait 运行清理代码](ch15-03-drop.md)
    - [`Rc<T>` 引用计数智能指针](ch15-04-rc.md)
    - [`RefCell<T>` 与内部可变性模式](ch15-05-interior-mutability.md)
    - [引用循环会导致内存泄漏](ch15-06-reference-cycles.md)

- [无畏并发](ch16-00-concurrency.md)
    - [使用线程同时地运行代码](ch16-01-threads.md)
    - [使用消息传递在线程间通信](ch16-02-message-passing.md)
    - [共享状态并发](ch16-03-shared-state.md)
    - [使用 `Sync` 与 `Send` Traits 的可扩展并发：](ch16-04-extensible-concurrency-sync-and-send.md)

- [Rust 的面向对象编程特性](ch17-00-oop.md)
    - [面向对象语言的特征](ch17-01-what-is-oo.md)
    - [顾及不同类型值的 trait 对象](ch17-02-trait-objects.md)
    - [面向对象设计模式的实现](ch17-03-oo-design-patterns.md)

## 高级主题

- [模式与模式匹配](ch18-00-patterns.md)
    - [所有可能会用到模式的位置](ch18-01-all-the-places-for-patterns.md)
    - [Refutability（可反驳性）: 模式是否会匹配失效](ch18-02-refutability.md)
    - [模式语法](ch18-03-pattern-syntax.md)

- [高级特征](ch19-00-advanced-features.md)
    - [不安全 Rust](ch19-01-unsafe-rust.md)
    - [高级 trait](ch19-03-advanced-traits.md)
    - [高级类型](ch19-04-advanced-types.md)
    - [高级函数与闭包](ch19-05-advanced-functions-and-closures.md)
    - [宏](ch19-06-macros.md)

- [最后的项目：构建多线程 web server](ch20-00-final-project-a-web-server.md)
    - [建立单线程 web server](ch20-01-single-threaded.md)
    - [将单线程 server 变为多线程 server](ch20-02-multithreaded.md)
    - [优雅停机与清理](ch20-03-graceful-shutdown-and-cleanup.md)

- [附录](appendix-00.md)
    - [A - 关键字](appendix-01-keywords.md)
    - [B - 运算符与符号](appendix-02-operators.md)
    - [C - 可派生的 trait](appendix-03-derivable-traits.md)
    - [D - 实用开发工具](appendix-04-useful-development-tools.md)
    - [E - 版本](appendix-05-editions.md)
    - [F - 本书译本](appendix-06-translation.md)
    - [G - Rust 是如何开发的与 “Nightly Rust”](appendix-07-nightly-rust.md)

---

--- METRICS ---
- Files Extracted: 2
- Estimated Token Budget: ~1746 tokens
- Canonical Reference: https://codewiki.google/github.com/KaiserY/trpl-zh-cn