Rust 提供了一套强大的模块(module)系统,可以将代码按层次分成多个逻辑 单元(模块),并管理这些模块之间的可见性(公有(public)或私有(private))。
模块是项的集合,项可以是:函数,结构体,trait,impl 块,甚至其他模块。

可见性

模块中只有公有的(public)项可以从模块外的作用域访问。

  • 在同一模块中,项可以访问其它项,即使它是私有的。
  • 模块也可以嵌套。
  • 嵌套模块的可见性遵循相同的规则。
  • 模块机制消除了相同名字的项之间的歧义。 ``rust // 一个名为my_mod` 的模块 mod my_mod { // 模块也可以嵌套 pub mod nested {

    1. // 使用 `pub(in path)` 语法定义的函数只在给定的路径中可见。
    2. // `path` 必须是父模块(parent module)或祖先模块(ancestor module)
    3. pub(in my_mod) fn public_function_in_my_mod() {
    4. print!("called `my_mod::nested::public_function_in_my_mod()`, that\n > ");
    5. public_function_in_nested()
    6. }
    7. // 使用 `pub(self)` 语法定义的函数则只在当前模块中可见。
    8. pub(self) fn public_function_in_nested() {
    9. println!("called `my_mod::nested::public_function_in_nested");
    10. }
    11. // 使用 `pub(super)` 语法定义的函数只在父模块中可见。
    12. pub(super) fn public_function_in_super_mod() {
    13. println!("called my_mod::nested::public_function_in_super_mod");
    14. }

    }

    pub fn call_public_function_in_my_mod() {

    1. print!("called `my_mod::call_public_funcion_in_my_mod()`, that\n> ");
    2. nested::public_function_in_my_mod();
    3. print!("> ");
    4. nested::public_function_in_super_mod();

    }

    // pub(crate) 使得函数只在当前 crate 中可见 pub(crate) fn public_function_in_crate() {

    1. println!("called `my_mod::public_function_in_crate()");

    } }

fn main() { // pub(crate) 项可以在同一个 crate 中的任何地方访问 my_mod::public_function_in_crate();

  1. my_mod::call_public_function_in_my_mod();

}

  1. <a name="nq93x"></a>
  2. # 结构体的可见性
  3. 结构体的字段也是一个可见性的层次。意义是隐藏信息(即封装,encapsulation)。
  4. ```rust
  5. mod my {
  6. // 一个公有的结构体,带有一个公有的字段(类型为泛型 `T`)
  7. pub struct OpenBox<T> {
  8. pub contents: T,
  9. }
  10. // 一个公有的结构体,带有一个私有的字段(类型为泛型 `T`)
  11. #[allow(dead_code)]
  12. pub struct ClosedBox<T> {
  13. contents: T,
  14. }
  15. impl<T> ClosedBox<T> {
  16. // 一个公有的构造器方法
  17. pub fn new(contents: T) -> ClosedBox<T> {
  18. ClosedBox {
  19. contents: contents,
  20. }
  21. }
  22. }
  23. }
  24. fn main() {
  25. // 带有公有字段的公有结构体,可以像平常一样构造
  26. let open_box = my::OpenBox { contents: "public information" };
  27. // 并且它们的字段可以正常访问到。
  28. println!("The open box contains: {}", open_box.contents);
  29. // 带有私有字段的公有结构体不能使用字段名来构造。
  30. // 并且一个结构体中的私有字段不能访问到。
  31. // 不过带有私有字段的结构体可以使用公有的构造器来创建。
  32. let _closed_box = my::ClosedBox::new("classified information");
  33. }

use 声明

use 声明可以将一个完整的路径绑定到一个新名字上,从而更容易访问。
use 绑定拥有局部作用域。

  1. // 将 `deeply::nested::function` 路径绑定到 `other_function`。
  2. use deeply::nested::function as other_function;
  3. fn function() {
  4. println!("called `function()`");
  5. }
  6. mod deeply {
  7. pub mod nested {
  8. pub fn function() {
  9. println!("called `deeply::nested::function()`")
  10. }
  11. }
  12. }
  13. fn main() {
  14. // 更容易访问 `deeply::nested::funcion`
  15. other_function();
  16. println!("Entering block");
  17. {
  18. // 这和 `use deeply::nested::function as function` 等价。
  19. // 此 `function()` 将掩蔽外部的同名函数。
  20. use deeply::nested::function;
  21. function();
  22. // `use` 绑定拥有局部作用域。在这个例子中,`function()`
  23. // 的掩蔽只存在在这个代码块中。
  24. println!("Leaving block");
  25. }
  26. function();
  27. }

super 和 self

可以在路径中使用 superself 关键字,从而在访问项时消除歧义,防止不必要的路径硬编码。

  • self 关键字表示当前的模块作用域,可以访问当前的作用域中函数,也可以访问内部的另一个模块。
  • super 关键字表示父作用域。

文件分层

模块可以分配到文件/目录的层次结构中。
mod 根据 pub 表示可见性。

  1. // 此声明将会查找名为 `my.rs` 或 `my/mod.rs` 的文件,并将该文件的内容放到
  2. // 此作用域中一个名为 `my` 的模块里面。
  3. mod my;