包和单元包

我们将要介绍的模块系统的第一部分是包和单元包。

单元包 是 Rust 编译器一次考虑的最少代码量。即使你运行 rustc 而不是 cargo 并传递单个源代码文件(就像我们在第 1 章的“编写和运行 Rust 程序”部分中所做的那样),编译器也会将该文件视为一个单元包。单元包可以包含模块,模块可以定义在与单元包一起编译的其他文件中,我们将在接下来的章节中看到。

一个单元包可以有两种形式:二进制单元包或库单元包。二进制单元包 是你可以编译成可执行文件并运行的程序,例如命令行程序或服务器。每个二进制单元包都必须有一个名为 main 的函数,用于定义可执行文件运行时发生的事情。到目前为止,我们创建的所有单元包都是二进制单元包。

库单元包 没有 main 函数,它们也不会编译成可执行文件。相反,它们定义了旨在与多个项目共享的功能。例如,我们在 第 2 章 中使用的 rand 单元包提供了生成随机数的功能。大多数时候,当 Rustaceans 说“单元包”时,他们指的是库单元包,并且他们将“单元包”与“库”的一般编程概念互换使用。

单元包根目录 是 Rust 编译器开始的源文件,它构成了你的单元包的根模块(我们将在 “定义模块来控制作用域和私有性”章节中深入解释模块)。

是一个或多个单元包的捆绑,提供一组功能。一个包包含一个 Cargo.toml 文件,用于描述如何构建这些单元包。Cargo 实际上是一个包,其中包含你一直在使用的命令行工具的二进制单元包。Cargo 包还包含一个库单元包,二进制单元包依赖于它。其他项目可以依赖 Cargo 库单元包来使用 Cargo 命令行工具使用的相同逻辑。一个包可以包含任意数量的二进制单元包,但最多只能包含一个库单元包。一个包必须至少包含一个单元包,无论是库单元包还是二进制单元包。

让我们逐步了解当我们创建一个包时会发生什么。首先,我们输入命令 cargo new my-project

$ cargo new my-project
     Created binary (application) `my-project` package
$ ls my-project
Cargo.toml
src
$ ls my-project/src
main.rs

在我们运行 cargo new my-project 后,我们使用 ls 查看 Cargo 创建的内容。在项目目录中,有一个 Cargo.toml 文件,为我们提供了一个包。还有一个 src 目录,其中包含 main.rs。在你的文本编辑器中打开 Cargo.toml,并注意没有提及 src/main.rs。Cargo 遵循一个约定,即 src/main.rs 是与包同名的二进制单元包的单元包根目录。同样,Cargo 知道,如果包目录包含 src/lib.rs,则该包包含一个与包同名的库单元包,而 src/lib.rs 是其单元包根目录。Cargo 将单元包根文件传递给 rustc 以构建库或二进制文件。

在这里,我们有一个只包含 src/main.rs 的包,这意味着它只包含一个名为 my-project 的二进制单元包。如果一个包包含 src/main.rssrc/lib.rs,它将有两个单元包:一个二进制单元包和一个库单元包,都与包同名。一个包可以通过将文件放在 src/bin 目录中来拥有多个二进制单元包:每个文件都将是一个单独的二进制单元包。