使用 use 关键字将路径引入作用域

每次调用函数时都必须写出完整的路径,这可能会让人感到不便和重复。在代码清单 7-7 中,无论我们选择绝对路径还是相对路径来调用 add_to_waitlist 函数,每次我们想要调用 add_to_waitlist 时,我们都必须指定 front_of_househosting。幸运的是,有一种方法可以简化这个过程:我们可以使用 use 关键字一次性地创建一个路径的快捷方式,然后在作用域内的其他任何地方使用这个较短的名称。

在代码清单 7-11 中,我们将 crate::front_of_house::hosting 模块引入了 eat_at_restaurant 函数的作用域中,因此我们只需要指定 hosting::add_to_waitlist 就可以在 eat_at_restaurant 中调用 add_to_waitlist 函数。

文件名:src/lib.rs

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

use crate::front_of_house::hosting;

pub fn eat_at_restaurant() {
    hosting::add_to_waitlist();
}

代码清单 7-11:使用 use 将模块引入作用域

在作用域中添加 use 和路径类似于在文件系统中创建符号链接。通过在 crate 根目录中添加 use crate::front_of_house::hostinghosting 现在在该作用域中是一个有效的名称,就像 hosting 模块是在 crate 根目录中定义的一样。使用 use 引入作用域的路径也会像任何其他路径一样检查私有性。

请注意,use 只会在其出现的特定作用域中创建快捷方式。代码清单 7-12 将 eat_at_restaurant 函数移动到一个名为 customer 的新子模块中,该子模块与 use 语句的作用域不同,因此函数体将无法编译。

文件名:src/lib.rs

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

use crate::front_of_house::hosting;

mod customer {
    pub fn eat_at_restaurant() {
        hosting::add_to_waitlist();
    }
}

代码清单 7-12:use 语句仅在其所在的作用域中有效

编译器错误表明快捷方式在 customer 模块中不再适用。

$ cargo build
   Compiling restaurant v0.1.0 (file:///projects/restaurant)
error[E0433]: failed to resolve: use of undeclared crate or module `hosting`
  --> src/lib.rs:11:9
   |
11 |         hosting::add_to_waitlist();
   |         ^^^^^^^ use of undeclared crate or module `hosting`
   |
help: consider importing this module through its public re-export
   |
10 +     use crate::hosting;
   |

warning: unused import: `crate::front_of_house::hosting`
 --> src/lib.rs:7:5
  |
7 | use crate::front_of_house::hosting;
  |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  |
  = note: `#[warn(unused_imports)]` on by default

For more information about this error, try `rustc --explain E0433`.
warning: `restaurant` (lib) generated 1 warning
error: could not compile `restaurant` (lib) due to 1 previous error; 1 warning emitted

请注意,还有一个警告,指出 use 在其作用域中不再使用!要解决此问题,请将 use 也移动到 customer 模块中,或者在子模块 customer 中使用 super::hosting 引用父模块中的快捷方式。

创建符合习惯用法的 use 路径

在代码清单 7-11 中,您可能想知道为什么我们指定了 use crate::front_of_house::hosting,然后在 eat_at_restaurant 中调用 hosting::add_to_waitlist,而不是像代码清单 7-13 那样将 use 路径一直指定到 add_to_waitlist 函数来实现相同的结果。

文件名:src/lib.rs

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

use crate::front_of_house::hosting::add_to_waitlist;

pub fn eat_at_restaurant() {
    add_to_waitlist();
}

代码清单 7-13:使用 useadd_to_waitlist 函数引入作用域,这不符合习惯用法

虽然代码清单 7-11 和 7-13 都完成了相同的任务,但代码清单 7-11 是使用 use 将函数引入作用域的惯用方式。使用 use 将函数的父模块引入作用域意味着我们在调用函数时必须指定父模块。在调用函数时指定父模块可以明确表明该函数不是本地定义的,同时仍然最大限度地减少了完整路径的重复。代码清单 7-13 中的代码不清楚 add_to_waitlist 的定义位置。

另一方面,在使用 use 引入结构体、枚举和其他项时,指定完整路径是惯用的做法。代码清单 7-14 展示了将标准库的 HashMap 结构体引入二进制 crate 作用域的惯用方式。

文件名:src/main.rs

use std::collections::HashMap;

fn main() {
    let mut map = HashMap::new();
    map.insert(1, 2);
}

代码清单 7-14:以惯用方式将 HashMap 引入作用域

这种惯例背后没有强烈的理由:它只是已经出现的约定,人们已经习惯于以这种方式阅读和编写 Rust 代码。

此惯例的例外情况是,如果我们使用 use 语句将两个同名项引入作用域,因为 Rust 不允许这样做。代码清单 7-15 展示了如何将两个同名的 Result 类型引入作用域,但它们的父模块不同,以及如何引用它们。

文件名:src/lib.rs

use std::fmt;
use std::io;

fn function1() -> fmt::Result {
    // --snip--
    Ok(())
}

fn function2() -> io::Result<()> {
    // --snip--
    Ok(())
}

代码清单 7-15:将两个同名类型引入同一作用域需要使用它们的父模块。

如您所见,使用父模块可以区分两种 Result 类型。如果我们改为指定 use std::fmt::Resultuse std::io::Result,那么我们在同一作用域中将有两个 Result 类型,而 Rust 将不知道我们在使用 Result 时指的是哪一个。

使用 as 关键字提供新名称

使用 use 将两个同名类型引入同一作用域的问题还有另一种解决方案:在路径之后,我们可以指定 as 和一个新的本地名称,或者说是类型的*别名*。代码清单 7-16 展示了另一种编写代码清单 7-15 中代码的方法,即使用 as 重命名两个 Result 类型中的一个。

文件名:src/lib.rs

use std::fmt::Result;
use std::io::Result as IoResult;

fn function1() -> Result {
    // --snip--
    Ok(())
}

fn function2() -> IoResult<()> {
    // --snip--
    Ok(())
}

代码清单 7-16:使用 as 关键字在将类型引入作用域时对其进行重命名

在第二个 use 语句中,我们为 std::io::Result 类型选择了新名称 IoResult,这不会与我们也引入作用域的 std::fmt 中的 Result 冲突。代码清单 7-15 和代码清单 7-16 被认为是惯用的,所以选择权在你!

使用 pub use 重新导出名称

当我们使用 use 关键字将名称引入作用域时,新作用域中可用的名称是私有的。为了使调用我们代码的代码能够像在其代码作用域中定义的那样引用该名称,我们可以组合使用 pubuse。这种技术称为*重新导出*,因为我们将一个项引入作用域,但也使该项可供其他人引入其作用域。

代码清单 7-17 展示了代码清单 7-11 中的代码,其中根模块中的 use 已更改为 pub use

文件名:src/lib.rs

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

pub use crate::front_of_house::hosting;

pub fn eat_at_restaurant() {
    hosting::add_to_waitlist();
}

代码清单 7-17:使用 pub use 使名称可供任何代码从新作用域中使用

在此更改之前,外部代码必须使用路径 restaurant::front_of_house::hosting::add_to_waitlist() 来调用 add_to_waitlist 函数,这也需要将 front_of_house 模块标记为 pub。现在,此 pub use 已从根模块重新导出了 hosting 模块,外部代码现在可以使用路径 restaurant::hosting::add_to_waitlist()

当代码的内部结构与调用代码的程序员对域的看法不同时,重新导出非常有用。例如,在这个餐厅的比喻中,经营餐厅的人会想到“前台”和“后台”。但光顾餐厅的顾客可能不会从这些方面来考虑餐厅的各个部分。使用 pub use,我们可以用一种结构编写代码,但公开另一种结构。这样做可以使我们的库对于在库上工作的程序员和调用库的程序员来说都井井有条。我们将在第 14 章的“使用 pub use 导出方便的公共 API”一节中,再来看一个 pub use 的例子,以及它如何影响你的 crate 文档。

使用外部包

在第 2 章中,我们编写了一个猜谜游戏项目,该项目使用名为 rand 的外部包来获取随机数。为了在我们的项目中使用 rand,我们在 *Cargo.toml* 中添加了以下行

文件名:Cargo.toml

rand = "0.8.5"

在 *Cargo.toml* 中将 rand 添加为依赖项会告诉 Cargo 从 crates.io 下载 rand 包和任何依赖项,并使 rand 可供我们的项目使用。

然后,为了将 rand 定义引入到我们包的作用域中,我们添加了一个以 crate 的名称 rand 开头的 use 行,并列出了我们想要引入作用域的项。回想一下,在第 2 章的“生成随机数一节中,我们将 Rng trait 引入作用域并调用了 rand::thread_rng 函数

use std::io;
use rand::Rng;

fn main() {
    println!("Guess the number!");

    let secret_number = rand::thread_rng().gen_range(1..=100);

    println!("The secret number is: {secret_number}");

    println!("Please input your guess.");

    let mut guess = String::new();

    io::stdin()
        .read_line(&mut guess)
        .expect("Failed to read line");

    println!("You guessed: {guess}");
}

Rust 社区的成员已经在 crates.io 上提供了许多包,将其中任何一个包引入到你的包中都涉及到这些相同的步骤:在你的包的 *Cargo.toml* 文件中列出它们,并使用 use 将来自它们的 crate 的项引入作用域。

请注意,标准 std 库也是我们包外部的一个 crate。因为标准库是随 Rust 语言一起提供的,所以我们不需要更改 *Cargo.toml* 来包含 std。但是我们确实需要使用 use 来引用它,以便将其中的项引入到我们包的作用域中。例如,对于 HashMap,我们将使用以下行

#![allow(unused)]
fn main() {
use std::collections::HashMap;
}

这是一个以标准库 crate 的名称 std 开头的绝对路径。

使用嵌套路径清理大型 use 列表

如果我们使用在同一个 crate 或同一个模块中定义的多个项,那么在每一行上单独列出每个项会占用我们文件中大量的垂直空间。例如,我们在代码清单 2-4 的猜谜游戏中使用的这两个 use 语句将 std 中的项引入作用域

文件名:src/main.rs

use rand::Rng;
// --snip--
use std::cmp::Ordering;
use std::io;
// --snip--

fn main() {
    println!("Guess the number!");

    let secret_number = rand::thread_rng().gen_range(1..=100);

    println!("The secret number is: {secret_number}");

    println!("Please input your guess.");

    let mut guess = String::new();

    io::stdin()
        .read_line(&mut guess)
        .expect("Failed to read line");

    println!("You guessed: {guess}");

    match guess.cmp(&secret_number) {
        Ordering::Less => println!("Too small!"),
        Ordering::Greater => println!("Too big!"),
        Ordering::Equal => println!("You win!"),
    }
}

相反,我们可以使用嵌套路径在一行中将相同的项引入作用域。我们通过指定路径的公共部分,后跟两个冒号,然后在大括号中列出路径中不同的部分来实现这一点,如代码清单 7-18 所示。

文件名:src/main.rs

use rand::Rng;
// --snip--
use std::{cmp::Ordering, io};
// --snip--

fn main() {
    println!("Guess the number!");

    let secret_number = rand::thread_rng().gen_range(1..=100);

    println!("The secret number is: {secret_number}");

    println!("Please input your guess.");

    let mut guess = String::new();

    io::stdin()
        .read_line(&mut guess)
        .expect("Failed to read line");

    let guess: u32 = guess.trim().parse().expect("Please type a number!");

    println!("You guessed: {guess}");

    match guess.cmp(&secret_number) {
        Ordering::Less => println!("Too small!"),
        Ordering::Greater => println!("Too big!"),
        Ordering::Equal => println!("You win!"),
    }
}

代码清单 7-18:指定嵌套路径以将具有相同前缀的多个项引入作用域

在更大的程序中,使用嵌套路径从同一个 crate 或模块中引入许多项可以大大减少所需的单独 use 语句的数量!

我们可以在路径的任何级别使用嵌套路径,这在组合两个共享子路径的 use 语句时非常有用。例如,代码清单 7-19 展示了两个 use 语句:一个将 std::io 引入作用域,另一个将 std::io::Write 引入作用域。

文件名:src/lib.rs

use std::io;
use std::io::Write;

代码清单 7-19:两个 use 语句,其中一个是另一个的子路径

这两个路径的公共部分是 std::io,这就是完整的第一个路径。要将这两个路径合并到一个 use 语句中,我们可以在嵌套路径中使用 self,如代码清单 7-20 所示。

文件名:src/lib.rs

use std::io::{self, Write};

代码清单 7-20:将代码清单 7-19 中的路径组合到一个 use 语句中

这一行将 std::iostd::io::Write 引入作用域。

通配符

如果我们想将路径中定义的*所有*公共项引入作用域,我们可以指定该路径,后跟 * 通配符

#![allow(unused)]
fn main() {
use std::collections::*;
}

这个 use 语句将 std::collections 中定义的所有公共项引入当前作用域。使用通配符时要小心!通配符可能会使我们更难分辨作用域中的名称以及程序中使用的名称的定义位置。

通配符通常在测试时使用,用于将所有被测内容引入 tests 模块;我们将在第 11 章的“如何编写测试一节中讨论这个问题。通配符有时也用作前奏模式的一部分:有关该模式的更多信息,请参阅标准库文档