Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

改进我们的I/O项目

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

使用迭代器移除 clone

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

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| {
        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(())
}
Listing 13-17: Reproduction of the Config::build function from Listing 12-23

当时，我们说不要担心低效的clone调用，因为我们会在未来移除它们。好吧，现在就是那个时候了！

我们需要在这里使用clone，因为我们有一个包含String元素的切片在参数args中，但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 之前不会编译。

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 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(())
}
Listing 13-18: Passing the return value of env::args to Config::build

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

接下来，我们需要更新 Config::build 的定义。让我们将 Config::build 的签名改为如清单 13-19 所示。这仍然无法编译，因为我们需要更新函数体。

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 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(())
}
Listing 13-19: Updating the signature of Config::build to expect an iterator

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

我们已经更新了 Config::build 函数的签名，使参数 args 具有带有特质边界 impl Iterator<Item = String> 的泛型类型，而不是 &[String]。这种使用 impl Trait 语法的方式我们在第十章的 “特质作为参数” 部分讨论过，意味着 args 可以是任何实现了 Iterator 特质并返回 String 项的类型。

因为我们将拥有 args 并且通过迭代 args 来对其进行修改，我们可以在 args 参数的定义中添加 mut 关键字使其可变。

使用 Iterator 特性方法而不是索引

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

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 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(())
}
Listing 13-20: Changing the body of Config::build to use iterator methods

记住，env::args 返回值中的第一个值是程序的名称。我们希望忽略它并获取下一个值，所以首先我们调用 next 并不对返回值做任何处理。然后我们再次调用 next 来获取要放入 Config 的 query 字段的值。如果 next 返回 Some，我们使用 match 来提取值。如果它返回 None，则意味着提供的参数不足，我们提前返回一个 Err 值。对于 file_path 值，我们做同样的处理。

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

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

Filename: src/lib.rs 
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));
    }
}
Listing 13-21: The implementation of the search function from Listing 12-19

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

Filename: src/lib.rs 
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)
        );
    }
}
Listing 13-22: Using iterator adapter methods in the implementation of the search function

回忆一下，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 程序员更喜欢使用迭代器风格。一开始可能稍微难掌握一些，但一旦你熟悉了各种迭代器适配器及其功能，迭代器就更容易理解了。代码不再纠结于各种循环和构建新向量的细节，而是专注于循环的高层次目标。这抽象掉了一些常见的代码，使得更容易看到该代码独有的概念，例如迭代器中每个元素必须通过的过滤条件。

但这两个实现真的等价吗？直观的假设可能是较低级别的循环会更快。让我们谈谈性能。