改进我们的 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 实例的所有权，我们不得不克隆 Config 的 query 和 file_path 字段中的值，以便 Config 实例可以拥有其值。
凭借关于迭代器的新知识，我们可以更改 build 函数，使其接受迭代器的所有权作为参数，而不是借用切片。我们将使用迭代器功能，而不是检查切片长度并索引特定位置的代码。这将使 Config::build 函数在做什么更清晰，因为迭代器将访问这些值。
一旦 Config::build 接受迭代器的所有权并停止使用借用的索引操作，我们就可以将 String 值从迭代器移动到 Config 中，而不是调用 clone 并进行新的分配。
直接使用返回的迭代器
打开你的 I/O 项目的 src/main.rs 文件，它应该看起来像这样：
文件名：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 程序员更喜欢使用迭代器风格。起初有点难掌握，但一旦你对各种迭代器适配器及其作用有了感觉，迭代器反而更容易理解。代码不再纠结于循环的各个细节和构建新向量，而是专注于循环的高级目标。这抽象掉了一些常见代码，使得更容易看到这段代码独有的概念，例如迭代器中每个元素必须通过的过滤条件。
但是这两种实现真的等价吗？直觉上的假设可能是底层循环会更快。让我们谈谈性能。