如何在结构字段上创建可变迭代器

Question

所以我正在使用 Rust 开发一个小的 NES 模拟器，我正在尝试使用我的状态寄存器。寄存器是一个结构，其中包含一些包含布尔值的字段（标志），寄存器本身是 CPU 结构的一部分。现在，我想遍历这些字段并根据我执行的一些指令设置 bool 值。但是，我无法实现可变迭代器，我已经实现了一个 into_iter() 函数并且能够遍历字段以获取/打印 bool 值，但是如何在结构本身内改变这些值？这甚至可能吗？

pub struct StatusRegister {
    CarryFlag: bool,
    ZeroFlag: bool,
    OverflowFlag: bool,
}

impl StatusRegister {
    fn new() -> Self {
        StatusRegister {
            CarryFlag: true,
            ZeroFlag: false,
            OverflowFlag: true,
        }
    }
}

impl<'a> IntoIterator for &'a StatusRegister {
    type Item = bool;
    type IntoIter = StatusRegisterIterator<'a>;

    fn into_iter(self) -> Self::IntoIter {
        StatusRegisterIterator {
            status: self,
            index: 0,
        }
    }
}

pub struct StatusRegisterIterator<'a> {
    status: &'a StatusRegister,
    index: usize,
}

impl<'a> Iterator for StatusRegisterIterator<'a> {
    type Item = bool;

    fn next(&mut self) -> Option<bool> {
        let result = match self.index {
            0 => self.status.CarryFlag,
            1 => self.status.ZeroFlag,
            2 => self.status.OverflowFlag,
            _ => return None,
        };
        self.index += 1;
        Some(result)
    }
}

pub struct CPU {
    pub memory: [u8; 0xffff],
    pub status: StatusRegister,
}

impl CPU {
    pub fn new() -> CPU {
        let memory = [0; 0xFFFF];
        CPU {
            memory,
            status: StatusRegister::new(),
        }
    }

    fn execute(&mut self) {
        let mut shifter = 0b1000_0000;
        for status in self.status.into_iter() {
            //mute status here!
            println!("{}", status);
            shifter <<= 1;
        }
    }
}

fn main() {
    let mut cpu = CPU::new();
    cpu.execute();
}

Answer 1

在可变引用上实现迭代器通常很困难。如果迭代器曾经两次返回对同一元素的引用，就会变得不健全。这意味着如果你想用纯粹安全的代码编写一个，你必须以某种方式说服编译器每个元素只被访问一次。这排除了简单地使用索引：您可能总是忘记增加索引或将其设置在某处，编译器将无法对此进行推理。

一种可能的解决方法是将多个std::iter::onces链接在一起（每个要迭代的引用一个）。

例如，

impl StatusRegister {
    fn iter_mut(&mut self) -> impl Iterator<Item = &mut bool> {
        use std::iter::once;
        once(&mut self.CarryFlag)
            .chain(once(&mut self.ZeroFlag))
            .chain(once(&mut self.OverflowFlag))
    }
}

（操场）

优点：

• 实施起来相当简单。
• 没有分配。
• 没有外部依赖。

缺点：

• 迭代器有一个非常复杂的类型：std::iter::Chain<std::iter::Chain<std::iter::Once<&mut bool>, std::iter::Once<&mut bool>>, std::iter::Once<&mut bool>>.

因此，如果您不想使用impl Iterator<Item = &mut bool>，则必须在代码中使用它。这包括实现IntoIteratorfor &mut StatusRegister，因为您必须明确指出IntoIter类型是什么。

另一种方法是使用数组或Vec保存所有可变引用（具有正确的生命周期），然后委托给它的迭代器实现来获取值。例如，

impl StatusRegister {
    fn iter_mut(&mut self) -> std::vec::IntoIter<&mut bool> {
        vec![
            &mut self.CarryFlag,
            &mut self.ZeroFlag,
            &mut self.OverflowFlag,
        ]
        .into_iter()
    }
}

（操场）

优点：

• 该类型更易于管理std::vec::IntoIter<&mut bool>。
• 实现起来还是相当简单的。
• 没有外部依赖。

缺点：

• 每次iter_mut调用都需要分配。

我还提到使用数组。这将避免分配，但事实证明数组还没有实现对它们的值的迭代器，所以上面的代码用 a[&mut bool; 3]而不是 aVec<&mut bool>将不起作用。但是，存在为大小有限的固定长度数组实现此功能的 crate，例如arrayvec(或array_vec)。

优点：

• 没有分配。
• 简单的迭代器类型。
• 实施简单。

缺点：

• 外部依赖。

我要讨论的最后一种方法是使用unsafe. 由于这与其他方法相比没有太多好处，因此我一般不推荐它。这主要是为了告诉你如何能实现这一点。

就像您的原始代码一样，我们将Iterator在我们自己的结构上实现。

impl StatusRegister {
    fn iter_mut(&mut self) -> std::vec::IntoIter<&mut bool> {
        vec![
            &mut self.CarryFlag,
            &mut self.ZeroFlag,
            &mut self.OverflowFlag,
        ]
        .into_iter()
    }
}

不安全来自next方法，我们必须（基本上）将类型转换&mut &mut T为&mut T，这通常是不安全的。但是，只要我们确保next不允许将这些可变引用作为别名，我们应该没问题。可能还有其他一些微妙的问题，所以我不保证这是合理的。就其价值而言，MIRI 没有发现任何问题。

impl<'a> Iterator for StatusRegisterIterMut<'a> {
    type Item = &'a mut bool;

    // Invariant to keep: index is 0, 1, 2 or 3
    // Every call, this increments by one, capped at 3
    // index should never be 0 on two different calls
    // and similarly for 1 and 2.
    fn next(&mut self) -> Option<Self::Item> {
        let result = unsafe {
            match self.index {
                // Safety: Since each of these three branches are
                // executed exactly once, we hand out no more than one mutable reference
                // to each part of self.status
                // Since self.status is valid for 'a
                // Each partial borrow is also valid for 'a
                0 => &mut *(&mut self.status.CarryFlag as *mut _),
                1 => &mut *(&mut self.status.ZeroFlag as *mut _),
                2 => &mut *(&mut self.status.OverflowFlag as *mut _),
                _ => return None
            }
        };
        // If self.index isn't 0, 1 or 2, we'll have already returned
        // So this bumps us up to 1, 2 or 3.
        self.index += 1;
        Some(result)
    }
}

（操场）

优点：

• 没有分配。
• 简单的迭代器类型名称。
• 没有外部依赖。

缺点：

• 实施起来复杂。要成功使用unsafe，您需要非常熟悉什么是允许的，什么是不允许的。到目前为止，这部分答案花了我最长的时间来确保我没有做错什么。
• 不安全会感染模块。在模块内通过与搞乱定义这个迭代器，我可以“安全地”的原因不健全status或index领域StatusRegisterIterMut。唯一允许封装的是在这个模块之外，那些字段是不可见的。