【问题标题】：Implement Iterator trait for a struct containing an iterable field为包含可迭代字段的结构实现迭代器特征
【发布时间】：2021-09-17 12:36:07
【问题描述】：

我想为包含可迭代字段的结构实现Iterator 特征。迭代我的结构应该产生与迭代字段相同的结果。这是我想要的（显然不起作用）：

struct Foo {
    bar: Vec<char>,
}

impl Iterator for Foo {
    type Item: &char; // Error: expected named lifetime parameter
    
    fn next(&mut self) -> Option<Self::Item> {
        self.bar.iter().next()
    }
}

为避免该错误，我尝试插入生命周期：

use std::marker::PhantomData;

struct Foo<'a> {
    bar: Vec<char>,
    phantom: &'a PhantomData<char> // not sure what to put inside < .. >
}

impl<'a> Iterator for Foo<'a> {
    type Item = &'a char;

    fn next(&mut self) -> Option<Self::Item> {
        self.bar.iter().next() // again, several errors about lifetimes
    }
}

如何为这样的结构实现 Iterator 特征？

【问题讨论】：

如果可能，您可能希望改为实现Deref。这样，您可以公开该字段的方法（包括.iter()），而无需为您的结构编写包装器。

标签： rust iterator traits

【解决方案1】：

创建Iterator 的东西和创建Iterator 的东西之间有很大的不同。例如，Vec<char> 可以产生一个迭代器，但它本身不是一个迭代器。这里有两个简单的例子，希望您能找到适合您用例的东西。

生成迭代器

根据您的情况，最简单的方法是为该字段实现Deref，然后让Vec<char> 处理它。或者，您可以为bar.iter() 编写一个包装函数。

pub struct Foo {
    bar: Vec<char>,
}

impl Deref for Foo {
    type Target = Vec<char>;

    fn deref(&self) -> &Self::Target {
        &self.bar
    }
}

let foo = Foo { bar: vec!['a', 'b', 'c', 'd'] };

// deref is implicitly called so foo.iter() represents foo.bar.iter()
for x in foo.iter() {
    println!("{:?}", x);
}

编写迭代器

以下是您如何为Vec<char> 编写自己的迭代器。请注意 Vec 如何存储为引用而不是拥有的值。这使得 rust 可以解决生命周期的限制。通过在迭代器的生命周期内持有一个不可变的引用，我们保证由该迭代器产生的引用也可以在该生命周期内持续存在。如果我们使用拥有的值，我们只能保证元素引用的生命周期持续到下一次对迭代器进行可变引用。或者换句话说，每个值只能持续到再次调用next。然而，即使这样也需要夜间功能才能正确表达。

pub struct SimpleIter<'a> {
    values: &'a Vec<char>,
    index: usize,
}

impl<'a> Iterator for SimpleIter<'a> {
    type Item = &'a char;
    
    fn next(&mut self) -> Option<Self::Item> {
        if self.index >= self.values.len() {
            return None
        }
        
        self.index += 1;
        Some(&self.values[self.index - 1])
    }
}

这是一个通用迭代器包装另一个迭代器的简单示例。

// Add ?Sized so Foo can hold a dynamically sized type to satisfy IntoFoo
struct Foo<I: ?Sized> {
    bar: I,
}

impl<I: Iterator> Iterator for Foo<I> {
    type Item = <I as Iterator>::Item;
    
    fn next(&mut self) -> Option<Self::Item> {
        println!("Iterating through Foo");
        self.bar.next()
    }
}

您还可以通过创建一个易于使用Foo 的特征来获得更多花哨的功能。

pub trait IntoFoo {
    fn iter_foo(self) -> Foo<Self>;
}

// Add an iter_foo() method for all existing iterators
impl<T: Iterator> IntoFoo for T {
    fn iter_foo(self) -> Foo<Self> {
        Foo { bar: self }
    }
}


let values = vec!['a', 'b', 'c', 'd'];

// Get default iterator and wrap it with our foo iterator
let foo: Foo<std::slice::Iter<'_, char>> = values.iter().iter_foo();

for x in foo {
    println!("{:?}", x);
}

【讨论】：

【解决方案2】：

迭代器是一个有状态的对象，它会记住它在底层集合中的位置。在您的示例中，对 next() 的每次调用都会从头开始迭代并返回第一个元素（前提是错误已修复）。

为Foo 实现Iterator 意味着实例本身在每次调用next() 时都会发生变化，这就是迭代器通常有自己的结构的原因。

如果你想提供迭代能力，我建议添加一个iter() 函数，它可以返回一个std::slice::Iter（Vec::iter() 返回）。

struct Foo {
    bar: Vec<char>,
}

impl Foo { 
    pub fn iter(&self) -> impl Iterator<Item=&char> + '_ {
        self.bar.iter()
    }
}

【讨论】：