Rust 程序设计语言

使用迭代器处理一系列元素

迭代器模式允许你对一个序列中的元素依次执行某项任务。迭代器负责遍历每个元素并确定序列何时结束的逻辑。当你使用迭代器时，不必自己重新实现该逻辑。

在 Rust 中，迭代器是惰性的，这意味着在你调用消耗迭代器的方法来使用它之前，它们不会产生任何效果。例如，清单 13-10 中的代码通过调用 Vec<T> 上定义的 iter 方法，创建了一个遍历向量 v1 中元素的迭代器。这段代码本身并没有做任何有用的事情。

fn main() {
    let v1 = vec![1, 2, 3];

    let v1_iter = v1.iter();
}

迭代器存储在 v1_iter 变量中。创建迭代器后，我们可以用多种方式使用它。在清单 3-5 中，我们使用 for 循环遍历数组，对其每个元素执行一些代码。在底层，这隐式地创建了一个迭代器然后消耗它，但我们一直回避了它具体是如何工作的。

在清单 13-11 的示例中，我们将迭代器的创建与在 for 循环中使用迭代器分开。当使用 v1_iter 中的迭代器调用 for 循环时，迭代器中的每个元素在循环的一次迭代中被使用，从而打印出每个值。

fn main() {
    let v1 = vec![1, 2, 3];

    let v1_iter = v1.iter();

    for val in v1_iter {
        println!("Got: {val}");
    }
}

在标准库不提供迭代器的语言中，你很可能会通过以下方式编写相同的功能：将一个变量初始化为索引 0，用该变量索引向量获取值，并在循环中递增该变量的值，直到它达到向量中元素的总数。

迭代器为你处理所有这些逻辑，减少了你可能会搞乱的重复代码。迭代器让你更灵活地对许多不同类型的序列使用相同的逻辑，而不仅仅是像向量这样你可以索引的数据结构。让我们来看看迭代器是如何做到这一点的。

Iterator trait 和 next 方法

所有迭代器都实现了一个名为 Iterator 的 trait，它定义在标准库中。该 trait 的定义如下所示：

#![allow(unused)]
fn main() {
pub trait Iterator {
    type Item;

    fn next(&mut self) -> Option<Self::Item>;

    // methods with default implementations elided
}
}

请注意，此定义使用了一些新语法：type Item 和 Self::Item，它们正在为该 trait 定义一个关联类型。我们将在第 20 章深入讨论关联类型。目前，你只需要知道这段代码表示实现 Iterator trait 要求你也定义一个 Item 类型，并且这个 Item 类型用于 next 方法的返回类型。换句话说，Item 类型将是从迭代器返回的类型。

Iterator trait 只要求实现者定义一个方法：next 方法，它一次返回迭代器的一个项，包裹在 Some 中，当迭代结束时返回 None。

我们可以直接在迭代器上调用 next 方法；清单 13-12 演示了在从向量创建的迭代器上重复调用 next 会返回什么值。

#[cfg(test)]
mod tests {
    #[test]
    fn iterator_demonstration() {
        let v1 = vec![1, 2, 3];

        let mut v1_iter = v1.iter();

        assert_eq!(v1_iter.next(), Some(&1));
        assert_eq!(v1_iter.next(), Some(&2));
        assert_eq!(v1_iter.next(), Some(&3));
        assert_eq!(v1_iter.next(), None);
    }
}

请注意，我们需要将 v1_iter 设为可变：在迭代器上调用 next 方法会改变迭代器用来跟踪其在序列中位置的内部状态。换句话说，这段代码消耗了迭代器，或者说用完了迭代器。每次调用 next 都会从迭代器中吃掉一个项。当我们使用 for 循环时，不需要将 v1_iter 设为可变，因为循环获取了 v1_iter 的所有权并在后台将其设为可变。

还要注意，我们从 next 调用中获得的值是对向量中值的不可变引用。iter 方法生成一个遍历不可变引用的迭代器。如果我们想创建一个获取 v1 所有权并返回拥有的值的迭代器，可以调用 into_iter 而不是 iter。类似地，如果我们想遍历可变引用，可以调用 iter_mut 而不是 iter。

消耗迭代器的方法

Iterator trait 有许多不同的方法，它们带有标准库提供的默认实现；你可以通过查看标准库 API 文档中 Iterator trait 的内容来了解这些方法。其中一些方法在其定义中调用 next 方法，这就是为什么在实现 Iterator trait 时要求你实现 next 方法。

调用 next 的方法称为消耗适配器，因为调用它们会用完迭代器。一个例子是 sum 方法，它获取迭代器的所有权并通过重复调用 next 来遍历项，从而消耗迭代器。在遍历过程中，它将每个项加到一个运行总和中，并在迭代完成时返回总和。清单 13-13 有一个演示 sum 方法用法的测试。

#[cfg(test)]
mod tests {
    #[test]
    fn iterator_sum() {
        let v1 = vec![1, 2, 3];

        let v1_iter = v1.iter();

        let total: i32 = v1_iter.sum();

        assert_eq!(total, 6);
    }
}

在调用 sum 之后，我们不允许使用 v1_iter，因为 sum 获取了我们调用它的迭代器的所有权。

生成其他迭代器的方法

迭代器适配器是定义在 Iterator trait 上的方法，它们不会消耗迭代器。相反，它们通过改变原始迭代器的某些方面来生成不同的迭代器。

清单 13-14 展示了调用迭代器适配器方法 map 的示例，该方法接受一个闭包，在遍历项时对每个项调用该闭包。map 方法返回一个生成修改后项的新迭代器。这里的闭包创建了一个新迭代器，其中向量中的每个项都将加 1。

fn main() {
    let v1: Vec<i32> = vec![1, 2, 3];

    v1.iter().map(|x| x + 1);
}

但是，此代码会产生一个警告：

$ cargo run
   Compiling iterators v0.1.0 (file:///projects/iterators)
warning: unused `Map` that must be used
 --> src/main.rs:4:5
  |
4 |     v1.iter().map(|x| x + 1);
  |     ^^^^^^^^^^^^^^^^^^^^^^^^
  |
  = note: iterators are lazy and do nothing unless consumed
  = note: `#[warn(unused_must_use)]` (part of `#[warn(unused)]`) on by default
help: use `let _ = ...` to ignore the resulting value
  |
4 |     let _ = v1.iter().map(|x| x + 1);
  |     +++++++

warning: `iterators` (bin "iterators") generated 1 warning
    Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.47s
     Running `target/debug/iterators`

清单 13-14 中的代码什么都不做；我们指定的闭包从未被调用。警告提醒我们原因：迭代器适配器是惰性的，我们需要在这里消耗迭代器。

为了修复此警告并消耗迭代器，我们将使用 collect 方法，我们在清单 12-1 中与 env::args 一起使用过它。此方法消耗迭代器并将结果值收集到一个集合数据类型中。

在清单 13-15 中，我们将遍历 map 调用返回的迭代器的结果收集到一个向量中。这个向量最终将包含原始向量中的每个项，每个项都加了 1。

fn main() {
    let v1: Vec<i32> = vec![1, 2, 3];

    let v2: Vec<_> = v1.iter().map(|x| x + 1).collect();

    assert_eq!(v2, vec![2, 3, 4]);
}

因为 map 接受一个闭包，我们可以指定要对每个项执行的任何操作。这是一个很好的例子，说明闭包如何让你在复用 Iterator trait 提供的迭代行为的同时定制某些行为。

你可以链接多次调用迭代器适配器，以可读的方式执行复杂操作。但因为所有迭代器都是惰性的，你必须调用其中一个消耗适配器方法才能从迭代器适配器的调用中获得结果。

捕获其环境的闭包

许多迭代器适配器接受闭包作为参数，通常我们指定为迭代器适配器参数的闭包将是捕获其环境的闭包。

在本例中，我们将使用接受闭包的 filter 方法。该闭包从迭代器获取一个项并返回一个 bool。如果闭包返回 true，该值将包含在 filter 生成的迭代器中。如果闭包返回 false，该值将不被包含。

在清单 13-16 中，我们使用 filter 配合一个从环境中捕获 shoe_size 变量的闭包，来遍历 Shoe 结构体实例的集合。它将只返回指定尺码的鞋子。

#[derive(PartialEq, Debug)]
struct Shoe {
    size: u32,
    style: String,
}

fn shoes_in_size(shoes: Vec<Shoe>, shoe_size: u32) -> Vec<Shoe> {
    shoes.into_iter().filter(|s| s.size == shoe_size).collect()
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn filters_by_size() {
        let shoes = vec![
            Shoe {
                size: 10,
                style: String::from("sneaker"),
            },
            Shoe {
                size: 13,
                style: String::from("sandal"),
            },
            Shoe {
                size: 10,
                style: String::from("boot"),
            },
        ];

        let in_my_size = shoes_in_size(shoes, 10);

        assert_eq!(
            in_my_size,
            vec![
                Shoe {
                    size: 10,
                    style: String::from("sneaker")
                },
                Shoe {
                    size: 10,
                    style: String::from("boot")
                },
            ]
        );
    }
}

shoes_in_size 函数获取一个鞋子向量和一个鞋码作为参数。它返回一个只包含指定尺码鞋子的向量。

在 shoes_in_size 的体中，我们调用 into_iter 来创建一个获取向量所有权的迭代器。然后，我们调用 filter 将该迭代器适配为一个只包含闭包返回 true 的元素的新迭代器。

该闭包从环境中捕获 shoe_size 参数，并将该值与每只鞋的尺码进行比较，只保留指定尺码的鞋子。最后，调用 collect 将适配后的迭代器返回的值收集到函数返回的向量中。

测试表明，当我们调用 shoes_in_size 时，我们只得到与我们指定的值尺码相同的鞋子。