接受命令行参数
让我们一如既往地用 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 方法将其转换为一个集合,例如 vector,其中包含迭代器产生的所有元素。
列表 12-1 中的代码允许你的 minigrep 程序读取传给它的任何命令行参数,然后将这些值收集到一个 vector 中。
use std::env;
fn main() {
let args: Vec<String> = env::args().collect();
dbg!(args);
}
首先,我们用 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 将迭代器转换为一个包含迭代器产生的所有值的 vector。我们可以使用 collect 函数创建多种类型的集合,因此我们明确注解 args 的类型以指定我们想要一个字符串的 vector。虽然在 Rust 中你很少需要注解类型,但 collect 是你经常需要注解的函数之一,因为 Rust 无法推断出你想要的集合类型。
最后,我们使用调试宏打印 vector。让我们先尝试不带参数运行代码,然后带两个参数运行:
$ 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",
]
注意,vector 中的第一个值是 "target/debug/minigrep",它是我们的二进制文件的名称。这与 C 语言中参数列表的行为一致,让程序可以使用它们被调用时所用的名称来执行。如果你想在消息中打印程序名称,或根据用于调用程序的命令行别名改变程序的行为,能够访问程序名称通常很方便。但就本章的目的而言,我们会忽略它,只保存我们需要的两个参数。
将参数值保存在变量中
程序目前能够访问作为命令行参数指定的值。现在我们需要将这两个参数的值保存在变量中,以便在程序的其余部分使用这些值。我们在列表 12-2 中这样做。
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}");
}
正如我们在打印 vector 时看到的,程序名称占据了 vector 中的第一个值,位置在 args[0],因此我们从索引 1 开始取参数。minigrep 接受的第一个参数是我们要搜索的字符串,因此我们将第一个参数的引用放在变量 query 中。第二个参数将是文件路径,因此我们将第二个参数的引用放在变量 file_path 中。
我们暂时打印这些变量的值,以证明代码正在按我们的意图工作。让我们用参数 test 和 sample.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
太好了,程序正在运行!我们需要的参数值正被保存到正确的变量中。稍后我们会添加一些错误处理来应对某些潜在的错误情况,例如当用户没有提供参数时;目前我们会忽略这种情况,转而着手添加文件读取功能。