改进我们的 I/O 项目
有了这些关于迭代器的新知识，我们可以使用迭代器来改进第 12 章的 I/O 项目，使代码中的某些部分更加清晰和简洁。让我们看看迭代器如何改进我们的 Config::build 函数和 search 函数的实现。
使用迭代器移除一个 clone
在示例 12-6 中，我们添加了代码，获取了一个 String 值的切片，通过索引切片并克隆值来创建 Config 结构体的实例，从而使 Config 结构体拥有这些值。在示例 13-17 中，我们重现了示例 12-23 中 Config::build 函数的实现。
use std::env;
use std::error::Error;
use std::fs;
use std::process;
use minigrep::{search, search_case_insensitive};
fn main() {
let args: Vec<String> = env::args().collect();
let config = Config::build(&args).unwrap_or_else(|err| {
println!("Problem parsing arguments: {err}");
process::exit(1);
});
if let Err(e) = run(config) {
println!("Application error: {e}");
process::exit(1);
}
}
pub struct Config {
pub query: String,
pub file_path: String,
pub ignore_case: bool,
}
impl Config {
fn build(args: &[String]) -> Result<Config, &'static str> {
if args.len() < 3 {
return Err("not enough arguments");
}
let query = args[1].clone();
let file_path = args[2].clone();
let ignore_case = env::var("IGNORE_CASE").is_ok();
Ok(Config {
query,
file_path,
ignore_case,
})
}
}
fn run(config: Config) -> Result<(), Box<dyn Error>> {
let contents = fs::read_to_string(config.file_path)?;
let results = if config.ignore_case {
search_case_insensitive(&config.query, &contents)
} else {
search(&config.query, &contents)
};
for line in results {
println!("{line}");
}
Ok(())
}Config::build 函数的重现当时，我们说不必担心低效的 clone 调用，因为我们将来会移除它们。好吧，现在就是时候了！
我们在这里需要 clone，因为我们在参数 args 中有一个包含 String 元素的切片，但 build 函数并不拥有 args。为了返回 Config 实例的所有权，我们不得不从 query 和 file_path 字段克隆值，以便 Config 实例可以拥有其值。
有了关于迭代器的新知识，我们可以更改 build 函数，使其获取迭代器的所有权作为参数，而不是借用切片。我们将使用迭代器功能，而不是检查切片长度和索引特定位置的代码。这将澄清 Config::build 函数正在做什么，因为迭代器将访问这些值。
一旦 Config::build 获取了迭代器的所有权并停止使用借用的索引操作，我们可以将 String 值从迭代器移入 Config，而不是调用 clone 并进行新的分配。
直接使用返回的迭代器
打开你的 I/O 项目的 src/main.rs 文件，它应该如下所示：
Filename: src/main.rs
use std::env;
use std::error::Error;
use std::fs;
use std::process;
use minigrep::{search, search_case_insensitive};
fn main() {
let args: Vec<String> = env::args().collect();
let config = Config::build(&args).unwrap_or_else(|err| {
eprintln!("Problem parsing arguments: {err}");
process::exit(1);
});
// --snip--
if let Err(e) = run(config) {
eprintln!("Application error: {e}");
process::exit(1);
}
}
pub struct Config {
pub query: String,
pub file_path: String,
pub ignore_case: bool,
}
impl Config {
fn build(args: &[String]) -> Result<Config, &'static str> {
if args.len() < 3 {
return Err("not enough arguments");
}
let query = args[1].clone();
let file_path = args[2].clone();
let ignore_case = env::var("IGNORE_CASE").is_ok();
Ok(Config {
query,
file_path,
ignore_case,
})
}
}
fn run(config: Config) -> Result<(), Box<dyn Error>> {
let contents = fs::read_to_string(config.file_path)?;
let results = if config.ignore_case {
search_case_insensitive(&config.query, &contents)
} else {
search(&config.query, &contents)
};
for line in results {
println!("{line}");
}
Ok(())
}我们首先将示例 12-24 中的 main 函数开头改为示例 13-18 中的代码，这次使用了迭代器。在更新 Config::build 之前，这还不能编译。
use std::env;
use std::error::Error;
use std::fs;
use std::process;
use minigrep::{search, search_case_insensitive};
fn main() {
let config = Config::build(env::args()).unwrap_or_else(|err| {
eprintln!("Problem parsing arguments: {err}");
process::exit(1);
});
// --snip--
if let Err(e) = run(config) {
eprintln!("Application error: {e}");
process::exit(1);
}
}
pub struct Config {
pub query: String,
pub file_path: String,
pub ignore_case: bool,
}
impl Config {
fn build(args: &[String]) -> Result<Config, &'static str> {
if args.len() < 3 {
return Err("not enough arguments");
}
let query = args[1].clone();
let file_path = args[2].clone();
let ignore_case = env::var("IGNORE_CASE").is_ok();
Ok(Config {
query,
file_path,
ignore_case,
})
}
}
fn run(config: Config) -> Result<(), Box<dyn Error>> {
let contents = fs::read_to_string(config.file_path)?;
let results = if config.ignore_case {
search_case_insensitive(&config.query, &contents)
} else {
search(&config.query, &contents)
};
for line in results {
println!("{line}");
}
Ok(())
}env::args 的返回值传递给 Config::buildenv::args 函数返回一个迭代器！现在，我们不将迭代器值收集到向量中然后将切片传递给 Config::build，而是直接将 env::args 返回的迭代器的所有权传递给 Config::build。
接下来，我们需要更新 Config::build 的定义。让我们将 Config::build 的签名改为示例 13-19 所示。这仍然不能编译，因为我们需要更新函数体。
use std::env;
use std::error::Error;
use std::fs;
use std::process;
use minigrep::{search, search_case_insensitive};
fn main() {
let config = Config::build(env::args()).unwrap_or_else(|err| {
eprintln!("Problem parsing arguments: {err}");
process::exit(1);
});
if let Err(e) = run(config) {
eprintln!("Application error: {e}");
process::exit(1);
}
}
pub struct Config {
pub query: String,
pub file_path: String,
pub ignore_case: bool,
}
impl Config {
fn build(
mut args: impl Iterator<Item = String>,
) -> Result<Config, &'static str> {
// --snip--
if args.len() < 3 {
return Err("not enough arguments");
}
let query = args[1].clone();
let file_path = args[2].clone();
let ignore_case = env::var("IGNORE_CASE").is_ok();
Ok(Config {
query,
file_path,
ignore_case,
})
}
}
fn run(config: Config) -> Result<(), Box<dyn Error>> {
let contents = fs::read_to_string(config.file_path)?;
let results = if config.ignore_case {
search_case_insensitive(&config.query, &contents)
} else {
search(&config.query, &contents)
};
for line in results {
println!("{line}");
}
Ok(())
}Config::build 的签名以期望迭代器env::args 函数的标准库文档显示，它返回的迭代器的类型是 std::env::Args，该类型实现了 Iterator trait 并返回 String 值。
我们更新了 Config::build 函数的签名，使参数 args 具有泛型类型，并带有 trait 约束 impl Iterator<Item = String> 而不是 &[String]。我们在第 10 章的“使用 Trait 作为参数”部分讨论的这种 impl Trait 语法意味着 args 可以是任何实现了 Iterator trait 并返回 String 项的类型。
因为我们正在获取 args 的所有权，并且将通过遍历它来修改 args，我们可以在 args 参数的规范中添加 mut 关键字使其可变。
使用 Iterator Trait 方法
接下来，我们将修复 Config::build 的函数体。因为 args 实现了 Iterator trait，我们知道可以在它上面调用 next 方法！示例 13-20 更新了示例 12-23 中的代码以使用 next 方法。
use std::env;
use std::error::Error;
use std::fs;
use std::process;
use minigrep::{search, search_case_insensitive};
fn main() {
let config = Config::build(env::args()).unwrap_or_else(|err| {
eprintln!("Problem parsing arguments: {err}");
process::exit(1);
});
if let Err(e) = run(config) {
eprintln!("Application error: {e}");
process::exit(1);
}
}
pub struct Config {
pub query: String,
pub file_path: String,
pub ignore_case: bool,
}
impl Config {
fn build(
mut args: impl Iterator<Item = String>,
) -> Result<Config, &'static str> {
args.next();
let query = match args.next() {
Some(arg) => arg,
None => return Err("Didn't get a query string"),
};
let file_path = match args.next() {
Some(arg) => arg,
None => return Err("Didn't get a file path"),
};
let ignore_case = env::var("IGNORE_CASE").is_ok();
Ok(Config {
query,
file_path,
ignore_case,
})
}
}
fn run(config: Config) -> Result<(), Box<dyn Error>> {
let contents = fs::read_to_string(config.file_path)?;
let results = if config.ignore_case {
search_case_insensitive(&config.query, &contents)
} else {
search(&config.query, &contents)
};
for line in results {
println!("{line}");
}
Ok(())
}Config::build 的函数体以使用迭代器方法记住，env::args 返回值中的第一个值是程序名称。我们想忽略它并获取下一个值，因此首先我们调用 next 并且不对返回值做任何操作。然后，我们调用 next 来获取我们想要放入 Config 的 query 字段的值。如果 next 返回 Some，我们使用 match 提取该值。如果它返回 None，意味着没有提供足够的参数，我们提前返回一个 Err 值。我们对 file_path 值做同样的事情。
使用迭代器适配器使代码更清晰
我们还可以利用 I/O 项目中 search 函数的迭代器，该函数在示例 13-21 中重现，与示例 12-19 中的相同。
pub fn search<'a>(query: &str, contents: &'a str) -> Vec<&'a str> {
let mut results = Vec::new();
for line in contents.lines() {
if line.contains(query) {
results.push(line);
}
}
results
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn one_result() {
let query = "duct";
let contents = "\
Rust:
safe, fast, productive.
Pick three.";
assert_eq!(vec!["safe, fast, productive."], search(query, contents));
}
}search 函数的实现我们可以使用迭代器适配器方法以更简洁的方式编写此代码。这样做还可以避免拥有一个可变的中间 results 向量。函数式编程风格倾向于最小化可变状态的数量以使代码更清晰。移除可变状态可能使未来的增强（如并行搜索）成为可能，因为我们不必管理对 results 向量的并发访问。示例 13-22 显示了此更改。
pub fn search<'a>(query: &str, contents: &'a str) -> Vec<&'a str> {
contents
.lines()
.filter(|line| line.contains(query))
.collect()
}
pub fn search_case_insensitive<'a>(
query: &str,
contents: &'a str,
) -> Vec<&'a str> {
let query = query.to_lowercase();
let mut results = Vec::new();
for line in contents.lines() {
if line.to_lowercase().contains(&query) {
results.push(line);
}
}
results
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn case_sensitive() {
let query = "duct";
let contents = "\
Rust:
safe, fast, productive.
Pick three.
Duct tape.";
assert_eq!(vec!["safe, fast, productive."], search(query, contents));
}
#[test]
fn case_insensitive() {
let query = "rUsT";
let contents = "\
Rust:
safe, fast, productive.
Pick three.
Trust me.";
assert_eq!(
vec!["Rust:", "Trust me."],
search_case_insensitive(query, contents)
);
}
}search 函数的实现中使用迭代器适配器方法回想一下，search 函数的目的是返回 contents 中包含 query 的所有行。与示例 13-16 中的 filter 示例类似，此代码使用 filter 适配器仅保留 line.contains(query) 返回 true 的行。然后，我们使用 collect 将匹配的行收集到另一个向量中。简单多了！你也可以自由地对 search_case_insensitive 函数进行相同的更改以使用迭代器方法。
为了进一步改进，可以通过移除对 collect 的调用并将返回类型更改为 impl Iterator<Item = &'a str> 来从 search 函数返回一个迭代器，这样函数就变成了一个迭代器适配器。注意，你还需要更新测试！在进行此更改前后，使用你的 minigrep 工具搜索大文件以观察行为差异。在此更改之前，程序在收集所有结果之前不会打印任何结果，但在更改之后，一旦找到每个匹配行，结果就会被打印出来，因为 run 函数中的 for 循环能够利用迭代器的惰性。
在循环和迭代器之间选择
下一个合理的问题是在你自己的代码中应该选择哪种风格以及为什么：示例 13-21 中的原始实现还是示例 13-22 中使用迭代器的版本（假设我们在返回结果之前收集所有结果，而不是返回迭代器）。大多数 Rust 程序员更喜欢使用迭代器风格。一开始要掌握它有点困难，但是一旦你熟悉了各种迭代器适配器及其作用，迭代器就会更容易理解。代码不是摆弄循环和构建新向量的各个部分，而是专注于循环的高级目标。这抽象掉了一些常见代码，使得更容易看到此代码特有的概念，例如迭代器中每个元素必须通过的过滤条件。
但是这两个实现真正等价吗？直观的假设可能是较低级别的循环会更快。让我们谈谈性能。