接受命令行参数

让我们用一如既往的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 程序读取传递给它的任何命令行参数,然后将这些值收集到一个向量中。

Filename: src/main.rs
use std::env;

fn main() {
    let args: Vec<String> = env::args().collect();
    dbg!(args);
}
Listing 12-1: Collecting the command line arguments into a vector and printing them

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

函数 args 和无效的 Unicode

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

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

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

$ cargo run
   Compiling minigrep v0.1.0 (file:///projects/minigrep)
    Finished `dev` profile [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` profile [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 中这样做。

Filename: 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}");
}
Listing 12-2: Creating variables to hold the query argument and file path argument

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

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

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

很好,程序正在运行!我们需要的参数值正在被保存到正确的变量中。稍后我们将添加一些错误处理来处理某些潜在的错误情况,例如用户未提供任何参数;目前,我们将忽略这种情况,而是专注于添加文件读取功能。