接收命令行参数

让我们像往常一样使用 cargo new 创建一个新项目。我们将这个项目命名为 minigrep,以便与你的系统上可能已经存在的 grep 工具区分开来。

$ cargo new minigrep
     Created binary (application) `minigrep` project
$ cd minigrep

第一个任务是让 minigrep 接收两个命令行参数:文件路径和要搜索的字符串。也就是说,我们希望能够使用 cargo run 运行程序,并使用两个连字符来指示后面的参数是传递给程序而不是 cargo 的,后面跟着要搜索的字符串和要搜索的文件的路径,如下所示:

$ cargo run -- searchstring example-filename.txt

现在,由 cargo new 生成的程序无法处理我们传递给它的参数。crates.io 上的一些现有库可以帮助编写接收命令行参数的程序,但因为你才刚刚学习这个概念,所以让我们自己来实现这个功能。

读取参数值

为了使 minigrep 能够读取传递给它的命令行参数的值,我们需要使用 Rust 标准库中提供的 std::env::args 函数。这个函数返回传递给 minigrep 的命令行参数的迭代器。我们将在 第 13 章 中全面介绍迭代器。现在,你只需要了解迭代器的两个细节:迭代器会生成一系列值,我们可以对迭代器调用 collect 方法,将其转换为包含迭代器生成的所有元素的集合,例如向量。

清单 12-1 中的代码允许你的 minigrep 程序读取传递给它的任何命令行参数,然后将这些值收集到一个向量中。

文件名:src/main.rs

use std::env;

fn main() {
    let args: Vec<String> = env::args().collect();
    dbg!(args);
}

清单 12-1:将命令行参数收集到向量中并打印它们

首先,我们使用 use 语句将 std::env 模块引入作用域,以便可以使用它的 args 函数。注意,std::env::args 函数嵌套在两层模块中。正如我们在 第 7 章 中讨论的那样在需要在多个模块中嵌套所需函数的情况下,我们选择将父模块引入作用域,而不是函数本身。这样做的好处是,我们可以轻松地使用 std::env 中的其他函数。这也比添加 use std::env::args 然后仅使用 args 调用函数更清晰明了,因为 args 很容易被误认为是在当前模块中定义的函数。

args 函数和无效的 Unicode

需要注意的是,如果任何参数包含无效的 Unicode,std::env::args 将会发生 panic。如果您的程序需要接受包含无效 Unicode 的参数,请改用 std::env::args_os。该函数返回一个迭代器,它生成 OsString 值而不是 String 值。为了简单起见,我们在这里选择使用 std::env::args,因为 OsString 值因平台而异,并且比 String 值更难处理。

main 函数的第一行,我们调用 env::args,并立即使用 collect 将迭代器转换为包含迭代器生成的所有值的向量。我们可以使用 collect 函数创建多种集合,因此我们明确地标注了 args 的类型,以指定我们想要一个字符串向量。尽管我们很少需要在 Rust 中标注类型,但 collect 是一个您经常需要标注的函数,因为 Rust 无法推断出您想要的集合类型。

最后,我们使用 debug 宏打印向量。让我们先尝试不带参数运行代码,然后再使用两个参数运行

$ cargo run
   Compiling minigrep v0.1.0 (file:///projects/minigrep)
    Finished dev [unoptimized + debuginfo] target(s) in 0.61s
     Running `target/debug/minigrep`
[src/main.rs:5:5] args = [
    "target/debug/minigrep",
]
$ cargo run -- needle haystack
   Compiling minigrep v0.1.0 (file:///projects/minigrep)
    Finished dev [unoptimized + debuginfo] target(s) in 1.57s
     Running `target/debug/minigrep needle haystack`
[src/main.rs:5:5] args = [
    "target/debug/minigrep",
    "needle",
    "haystack",
]

请注意,向量中的第一个值是 "target/debug/minigrep",它是我们二进制文件的名称。这与 C 语言中参数列表的行为相匹配,允许程序使用调用它们的名称来执行。如果要将程序名称打印在消息中,或者根据用于调用程序的命令行别名来更改程序的行为,那么能够访问程序名称通常很方便。但在本章中,我们将忽略它,只保存我们需要的两个参数。

将参数值保存在变量中

程序当前能够访问指定为命令行参数的值。现在我们需要将两个参数的值保存在变量中,以便我们可以在程序的其余部分使用这些值。我们在代码清单 12-2 中实现了这一点。

文件名:src/main.rs

use std::env;

fn main() {
    let args: Vec<String> = env::args().collect();

    let query = &args[1];
    let file_path = &args[2];

    println!("Searching for {query}");
    println!("In file {file_path}");
}

代码清单 12-2:创建变量来保存查询参数和文件路径参数

正如我们在打印向量时所看到的,程序的名称占据了 args[0] 处向量中的第一个值,因此我们从索引 1 开始参数。minigrep 接收的第一个参数是我们正在搜索的字符串,因此我们将对第一个参数的引用放在变量 query 中。第二个参数将是文件路径,因此我们将对第二个参数的引用放在变量 file_path 中。

我们暂时打印这些变量的值,以证明代码按预期工作。让我们再次使用参数 testsample.txt 运行此程序

$ cargo run -- test sample.txt
   Compiling minigrep v0.1.0 (file:///projects/minigrep)
    Finished dev [unoptimized + debuginfo] target(s) in 0.0s
     Running `target/debug/minigrep test sample.txt`
Searching for test
In file sample.txt

很好,程序正在工作!我们需要的参数值被保存到了正确的变量中。稍后我们将添加一些错误处理来处理某些潜在的错误情况,例如当用户没有提供参数时;现在,我们将忽略这种情况,而是致力于添加文件读取功能。