Rust for cpp devs - 用 Packages C

Rust 中包含三个不同层级的结构：

• package
• crate
• module

package 是由一个或多个 crates 组成，并且包含一个 Cargo.toml 配置文件来描述如何编译这些 crates。我们通过 cargo new my-project 创建出来的就是一个 package。而其中包含的 src/main.rs 就是默认创建的名为 my-project（与项目名相同）的二进制 crate。

crate 可以是一个二进制文件，或者是一个库文件。它将相关的功能组合在一个 scope 中，从而在不同的项目中共享。如果我们把 .rs 文件放入 src/bin 目录下，每个文件都会编译成一个独立的二进制 crate。

module 允许我们在 crate 内再细分代码，同时，它也控制哪些代码对外部可见(public)，哪些是私有的(private)。

Path and Module

我们使用 path 来指定某个 module。path 可以有两种表现形式：

• 绝对路径
  以 crate:: 作为”根目录“，类似于 linux 中的 /。
• 相对路径
  从当前模块开始的相对路径

路径用符号 :: 分隔。

这两者的区别是，如果经常把 module 定义和调用作为整体移动，则更适合相对路径。如果经常单独移动调用者，则更适合绝对路径。一般来讲，偏向使用绝对路径。

使用 Module 来管理 private 和 public

Module 中的函数、结构体等默认都是 private 的。我们需要使用 pub 指明是 public 的，例如：

mod front_of_house {
    pub mod hosting {
        pub fn add_to_waitlist() {}
        pub fn seat_at_table() {}
    }
}

这样才可以在同一个项目的另一个文件中如下调用：

mod front_of_house;

#[cfg(test)]
mod tests {
    #[test]
    fn test_eat_at_restaurant() {
        use crate::front_of_house::hosting;
        hosting::add_to_waitlist();
        hosting::seat_at_table();
    }
}

这里我们使用 use 关键字来将 hosting 引入当前 scope。类似于 python，我们也可以使用 as 来重命名。

use std::io::Result as IoResult;

将 module 放在不同文件中

实际项目中，我们不可能把所有代码都写在一个文件中。一般我们可以根据 module 来拆分成不同的文件。

mod front_of_house;

这行代码的意义是让 Rust 从另一个名为 src/front_of_house.rs 的文件中加载这个 module，有点类似于 C++ 的声明。只要把这行代码加入 lib.rs 或者 main.rs，Rust 就会去寻找并加载 front_of_house.rs 这个文件。注意，此时这个文件自身就是一个 module，无需再定义一个 front_of_house。

将 module 放入文件夹

如果希望将 module 放入文件夹，那么更加复杂一些。我们需要

1. 建立 src/front_of_house 文件夹，并在里面创建 src/front_of_house/hosting.rs 文件
2. 增加一个叫 src/front_of_house.rs 的文件，必须与文件夹同名
3. 在 src/front_of_house.rs 中添加代码声明 hosting 模块：

mod hosting;

4. 在 src/lib.rs 中添加代码声明 front_of_house 模块：

mod front_of_house;

使用外部 package

Rust 社区有很多 packages，我们只需要以下两步就能将 package 导入自己的项目。

• 在 Cargo.toml 配置文件中添加依赖的 package：

[dependencies]
rand = "0.5.5"

• 使用 use 将依赖的 package 引入 scope：

use rand::Rng;

fn main() {
    let secret_number = rand::thread_rng().gen_range(1, 101);
}

参考

1. Clear explanation of Rust’s module system