|
|
|
|
## 包和 Crate
|
|
|
|
|
|
|
|
|
|
<!-- https://github.com/rust-lang/book/blob/main/src/ch07-01-packages-and-crates.md -->
|
|
|
|
|
<!-- commit 02e053cdbbb3bf9edd9ad32ed49eb533404350a9 -->
|
|
|
|
|
|
|
|
|
|
模块系统的第一部分,我们将介绍包和 crate。
|
|
|
|
|
|
|
|
|
|
crate 是 Rust 在编译时最小的代码单位。即使你用 `rustc` 而不是 `cargo` 来编译一个单独的源代码文件(正如我们在第 1 章“编写并运行 Rust 程序”中所做的那样),编译器还是会将那个文件视为一个 crate。crate 可以包含模块,模块可以定义在其他文件,然后和 crate 一起编译,我们会在接下来的章节中遇到。
|
|
|
|
|
|
|
|
|
|
crate 有两种形式:二进制 crate 和库 crate。**二进制 crate**(*Binary crates*)可以被编译为可执行程序,比如命令行程序或者服务端。它们必须有一个名为 `main` 函数来定义当程序被执行的时候所需要做的事情。目前我们所创建的 crate 都是二进制 crate。
|
|
|
|
|
|
|
|
|
|
**库 crate**(*Library crates*)并没有 `main` 函数,它们也不会编译为可执行程序。相反它们定义了可供多个项目复用的功能模块。比如 [第二章][rand] 的 `rand` crate 就提供了生成随机数的功能。大多数时间 `Rustaceans` 说的 “crate” 指的都是库 crate,这与其他编程语言中 “library” 概念一致。
|
|
|
|
|
|
|
|
|
|
*crate root* 是一个源文件,Rust 编译器以它为起始点,并构成你的 crate 的根模块(我们将在 [“定义模块来控制作用域与私有性”][modules] 一节深入解读)。
|
|
|
|
|
|
|
|
|
|
*包*(*package*)是提供一系列功能的一个或者多个 crate 的捆绑。一个包会包含一个 *Cargo.toml* 文件,阐述如何去构建这些 crate。Cargo 实际上就是一个包,它包含了用于构建你代码的命令行工具的二进制 crate。其他项目也依赖 Cargo 库来实现与 Cargo 命令行程序一样的逻辑。
|
|
|
|
|
|
|
|
|
|
包中可以包含至多一个库 crate(library crate)。包中可以包含任意多个二进制 crate(binary crate),但是必须至少包含一个 crate(无论是库的还是二进制的)。
|
|
|
|
|
|
|
|
|
|
让我们来看看创建包的时候会发生什么。首先,我们输入命令 `cargo new my-project`:
|
|
|
|
|
|
|
|
|
|
```console
|
|
|
|
|
$ cargo new my-project
|
|
|
|
|
Created binary (application) `my-project` package
|
|
|
|
|
$ ls my-project
|
|
|
|
|
Cargo.toml
|
|
|
|
|
src
|
|
|
|
|
$ ls my-project/src
|
|
|
|
|
main.rs
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
运行了这条命令后,我们先用 `ls` (译者注:此命令为 Linux 平台的指令,Windows 下可用 dir)来看看 Cargo 给我们创建了什么,Cargo 会给我们的包创建一个 *Cargo.toml* 文件。查看 *Cargo.toml* 的内容,会发现并没有提到 *src/main.rs*,因为 Cargo 遵循的一个约定:*src/main.rs* 就是一个与包同名的二进制 crate 的 crate 根。同样的,Cargo 知道如果包目录中包含 *src/lib.rs*,则包带有与其同名的库 crate,且 *src/lib.rs* 是 crate 根。crate 根文件将由 Cargo 传递给 `rustc` 来实际构建库或者二进制项目。
|
|
|
|
|
|
|
|
|
|
在此,我们有了一个只包含 *src/main.rs* 的包,意味着它只含有一个名为 `my-project` 的二进制 crate。如果一个包同时含有 *src/main.rs* 和 *src/lib.rs*,则它有两个 crate:一个二进制的和一个库的,且名字都与包相同。通过将文件放在 *src/bin* 目录下,一个包可以拥有多个二进制 crate:每个 *src/bin* 下的文件都会被编译成一个独立的二进制 crate。
|
|
|
|
|
|
|
|
|
|
[modules]: ch07-02-defining-modules-to-control-scope-and-privacy.html
|
|
|
|
|
[rand]: ch02-00-guessing-game-tutorial.html#生成一个随机数
|