Rust 程序设计语言

改进我们的 I/O 项目

利用关于迭代器的新知识，我们可以通过使用迭代器来改进第 12 章中的 I/O 项目，使代码中的某些地方更清晰、更简洁。让我们看看迭代器如何改进我们对 Config::build 函数和 search 函数的实现。

使用迭代器移除 clone

在代码清单 12-6 中，我们添加了一些代码，这些代码接收一个 String 值切片，并通过索引到切片并克隆值来创建 Config 结构体的实例，从而允许 Config 结构体拥有这些值。在代码清单 13-17 中，我们复制了代码清单 12-23 中的 Config::build 函数的实现。

文件名：src/lib.rs

use std::env;
use std::error::Error;
use std::fs;

pub struct Config {
    pub query: String,
    pub file_path: String,
    pub ignore_case: bool,
}

impl Config {
    pub 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,
        })
    }
}

pub 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(())
}

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
}

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)
        );
    }
}

代码清单 13-17：复制代码清单 12-23 中的 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::process;

use minigrep::Config;

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) = minigrep::run(config) {
        eprintln!("Application error: {e}");
        process::exit(1);
    }
}

我们将首先将代码清单 12-24 中的 main 函数的开头更改为代码清单 13-18 中的代码，这次使用迭代器。在我们更新 Config::build 之前，这不会编译。

文件名：src/main.rs

use std::env;
use std::process;

use minigrep::Config;

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) = minigrep::run(config) {
        eprintln!("Application error: {e}");
        process::exit(1);
    }
}

代码清单 13-18：将 env::args 的返回值传递给 Config::build

env::args 函数返回一个迭代器！我们没有将迭代器值收集到一个向量中，然后将切片传递给 Config::build，而是直接将 env::args 返回的迭代器的所有权传递给 Config::build。

接下来，我们需要更新 Config::build 的定义。在 I/O 项目的 src/lib.rs 文件中，让我们将 Config::build 的签名更改为代码清单 13-19 中的样子。这仍然不会编译，因为我们需要更新函数体。

文件名：src/lib.rs

use std::env;
use std::error::Error;
use std::fs;

pub struct Config {
    pub query: String,
    pub file_path: String,
    pub ignore_case: bool,
}

impl Config {
    pub 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,
        })
    }
}

pub 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(())
}

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
}

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)
        );
    }
}

代码清单 13-19：更新 Config::build 的签名以接收迭代器

env::args 函数的标准库文档显示，它返回的迭代器的类型是 std::env::Args，并且该类型实现了 Iterator 特征并返回 String 值。

我们已经更新了 Config::build 函数的签名，因此参数 args 具有泛型类型，其特征边界为 impl Iterator<Item = String>，而不是 &[String]。我们在第 10 章的“特征作为参数”一节中讨论了 impl Trait 语法的这种用法，这意味着 args 可以是任何实现 Iterator 特征并返回 String 项目的类型。

因为我们要获取 args 的所有权，并且将通过迭代 args 来对其进行修改，所以我们可以在 args 参数的声明中添加 mut 关键字，使其可变。

使用 Iterator 特性方法代替索引

接下来，我们将修复 Config::build 的函数体。因为 args 实现了 Iterator 特性，我们知道可以在其上调用 next 方法！清单 13-20 更新了清单 12-23 中的代码，以使用 next 方法。

文件名：src/lib.rs

use std::env;
use std::error::Error;
use std::fs;

pub struct Config {
    pub query: String,
    pub file_path: String,
    pub ignore_case: bool,
}

impl Config {
    pub 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,
        })
    }
}

pub 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(())
}

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
}

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)
        );
    }
}

清单 13-20：更改 Config::build 的函数体以使用迭代器方法

请记住，env::args 返回值中的第一个值是程序的名称。我们想忽略它并获取下一个值，所以首先我们调用 next 并且不对返回值做任何处理。其次，我们调用 next 来获取要放入 Config 的 query 字段的值。如果 next 返回 Some，我们使用 match 来提取值。如果它返回 None，则意味着没有给出足够的参数，我们使用 Err 值提前返回。我们对 file_path 值执行相同的操作。

使用迭代器适配器使代码更清晰

我们还可以在 I/O 项目的 search 函数中利用迭代器，该函数在清单 13-21 中重现，与清单 12-19 中的相同。

文件名：src/lib.rs

use std::error::Error;
use std::fs;

pub struct Config {
    pub query: String,
    pub file_path: String,
}

impl Config {
    pub 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();

        Ok(Config { query, file_path })
    }
}

pub fn run(config: Config) -> Result<(), Box<dyn Error>> {
    let contents = fs::read_to_string(config.file_path)?;

    Ok(())
}

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));
    }
}

清单 13-21：清单 12-19 中 search 函数的实现

我们可以使用迭代器适配器方法以更简洁的方式编写此代码。这样做还可以避免使用可变的中间 results 向量。函数式编程风格倾向于最小化可变状态的数量，以使代码更清晰。删除可变状态可能会在未来增强功能，使搜索能够并行进行，因为我们不必管理对 results 向量的并发访问。清单 13-22 显示了此更改。

文件名：src/lib.rs

use std::env;
use std::error::Error;
use std::fs;

pub struct Config {
    pub query: String,
    pub file_path: String,
    pub ignore_case: bool,
}

impl Config {
    pub 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,
        })
    }
}

pub 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(())
}

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)
        );
    }
}

清单 13-22：在 search 函数的实现中使用迭代器适配器方法

回想一下，search 函数的目的是返回 contents 中包含 query 的所有行。与清单 13-16 中的 filter 示例类似，此代码使用 filter 适配器仅保留 line.contains(query) 返回 true 的行。然后，我们使用 collect 将匹配的行收集到另一个向量中。简单多了！您也可以随意进行相同的更改，在 search_case_insensitive 函数中使用迭代器方法。

在循环或迭代器之间进行选择

下一个逻辑问题是，您应该在自己的代码中选择哪种风格以及为什么：清单 13-21 中的原始实现还是清单 13-22 中使用迭代器的版本。大多数 Rust 程序员更喜欢使用迭代器风格。一开始可能有点难以上手，但是一旦您了解了各种迭代器适配器及其作用，迭代器就会更容易理解。代码不再纠结于循环的各个部分和构建新向量，而是专注于循环的高级目标。这抽象了一些常见的代码，因此更容易看到此代码中独有的概念，例如迭代器中每个元素必须通过的过滤条件。

但是这两种实现真的等效吗？直观的假设可能是，更底层的循环会更快。让我们谈谈性能。