如何使用返回可变引用的迭代器创建自己的数据结构？

Question

我在Rust中创建了一个数据结构,我想为它创建迭代器.不可变的迭代器很容易.我目前有这个,它工作正常:

// This is a mock of the "real" EdgeIndexes class as
// the one in my real program is somewhat complex, but
// of identical type

struct EdgeIndexes;

impl Iterator for EdgeIndexes {
    type Item = usize;
    fn next(&mut self) -> Option<Self::Item> {
        Some(0)
    }

    fn size_hint(&self) -> (usize, Option<usize>) {
        (0, None)
    }
}

pub struct CGraph<E> {
    nodes: usize,
    edges: Vec<E>,
}

pub struct Edges<'a, E: 'a> {
    index: EdgeIndexes,
    graph: &'a CGraph<E>,
}

impl<'a, E> Iterator for Edges<'a, E> {
    type Item = &'a E;

    fn next(&mut self) -> Option<Self::Item> {
        match self.index.next() {
            None => None,
            Some(x) => Some(&self.graph.edges[x]),
        }
    }

    fn size_hint(&self) -> (usize, Option<usize>) {
        self.index.size_hint()
    }
}

我想创建一个返回可变引用的迭代器.我尝试过这样做,但找不到让它编译的方法:

pub struct MutEdges<'a, E: 'a> {
    index: EdgeIndexes,
    graph: &'a mut CGraph<E>,
}

impl<'a, E> Iterator for MutEdges<'a, E> {
    type Item = &'a mut E;

    fn next(&mut self) -> Option<&'a mut E> {
        match self.index.next() {
            None => None,
            Some(x) => self.graph.edges.get_mut(x),
        }
    }

    fn size_hint(&self) -> (usize, Option<usize>) {
        self.index.size_hint()
    }
}

编译此结果会导致以下错误:

error[E0495]: cannot infer an appropriate lifetime for lifetime parameter in function call due to conflicting requirements
  --> src/lib.rs:54:24
   |
54 |             Some(x) => self.graph.edges.get_mut(x),
   |                        ^^^^^^^^^^^^^^^^
   |
note: first, the lifetime cannot outlive the anonymous lifetime #1 defined on the method body at 51:5...
  --> src/lib.rs:51:5
   |
51 | /     fn next(&mut self) -> Option<&'a mut E> {
52 | |         match self.index.next() {
53 | |             None => None,
54 | |             Some(x) => self.graph.edges.get_mut(x),
55 | |         }
56 | |     }
   | |_____^
note: ...so that reference does not outlive borrowed content
  --> src/lib.rs:54:24
   |
54 |             Some(x) => self.graph.edges.get_mut(x),
   |                        ^^^^^^^^^^^^^^^^
note: but, the lifetime must be valid for the lifetime 'a as defined on the impl at 48:6...
  --> src/lib.rs:48:6
   |
48 | impl<'a, E> Iterator for MutEdges<'a, E> {
   |      ^^
   = note: ...so that the expression is assignable:
           expected std::option::Option<&'a mut E>
              found std::option::Option<&mut E>

我不确定如何解释这些错误以及如何更改我的代码以允许MutEdges返回可变引用.

使用代码链接到游乐场.

Answer 1

您无法编译它,因为可变引用比不可变引用更具限制性.一个简短的版本说明了这个问题:

struct MutIntRef<'a> {
    r: &'a mut i32
}

impl<'a> MutIntRef<'a> {
    fn mut_get(&mut self) -> &'a mut i32 {
        &mut *self.r
    }
}

fn main() {
    let mut i = 42;
    let mut mir = MutIntRef { r: &mut i };
    let p = mir.mut_get();
    let q = mir.mut_get();
    println!("{}, {}", p, q);
}

这产生了同样的错误:

error[E0495]: cannot infer an appropriate lifetime for borrow expression due to conflicting requirements
 --> src/main.rs:7:9
  |
7 |         &mut *self.r
  |         ^^^^^^^^^^^^
  |
note: first, the lifetime cannot outlive the anonymous lifetime #1 defined on the method body at 6:5...
 --> src/main.rs:6:5
  |
6 | /     fn mut_get(&mut self) -> &'a mut i32 {
7 | |         &mut *self.r
8 | |     }
  | |_____^
note: ...so that reference does not outlive borrowed content
 --> src/main.rs:7:9
  |
7 |         &mut *self.r
  |         ^^^^^^^^^^^^
note: but, the lifetime must be valid for the lifetime 'a as defined on the impl at 5:6...
 --> src/main.rs:5:6
  |
5 | impl<'a> MutIntRef<'a> {
  |      ^^
note: ...so that reference does not outlive borrowed content
 --> src/main.rs:7:9
  |
7 |         &mut *self.r
  |         ^^^^^^^^^^^^

如果我们看一下main函数,我们会调用两个可变引用,p并且q它们都是别名的内存位置i.这是不允许的.在Rust中,我们不能有两个别名可用的可变引用.这种限制的动机是观察到突变和混叠在记忆安全方面不能很好地发挥作用.因此,编译器拒绝代码是件好事.如果像这样的东西编译,很容易得到各种内存损坏错误.

Rust避免这种危险的方式是保留最多可用的一个可变引用.因此,如果你想基于对Y所拥有的Y的可变引用创建对X的可变引用,我们最好确保只要存在对X的引用,我们就不能再触及对Y的另一个引用了. .在Rust中,这是通过一生和借用来实现的.编译器认为在这种情况下借用原始引用,这也会影响结果引用的生命周期参数.如果我们改变

fn mut_get(&mut self) -> &'a mut i32 {
    &mut *self.r
}

至

fn mut_get(&mut self) -> &mut i32 { // <-- no 'a anymore
    &mut *self.r // Ok!
}

编译器停止抱怨此get_mut功能.现在返回与匹配一辈子参数的引用&self,而不是'a了.这就是mut_get你"借"的功能self.这就是编译器抱怨不同位置的原因:

error[E0499]: cannot borrow `mir` as mutable more than once at a time
  --> src/main.rs:15:13
   |
14 |     let p = mir.mut_get();
   |             --- first mutable borrow occurs here
15 |     let q = mir.mut_get();
   |             ^^^ second mutable borrow occurs here
16 |     println!("{}, {}", p, q);
   |                        - first borrow later used here

显然,编译器确实没有考虑mir到借用.这很好.这意味着现在只有一种方法可以达到以下内存位置i:p.

现在您可能想知道:标准库作者是如何设法编写可变向量迭代器的？答案很简单:他们使用了不安全的代码.没有其他办法.Rust编译器根本不知道每当你向下一个元素请求一个可变向量迭代器时,你每次都得到一个不同的引用,并且两次都不会引用相同的引用.当然,我们知道这样的迭代器不会给你两次相同的引用.这样可以安全地提供您习惯的这种界面.我们不需要"冻结"这样的迭代器.如果迭代器返回的引用不重叠,则不必借用迭代器来访问元素.在内部,这是使用不安全的代码(将原始指针转换为引用)完成的.

您的问题的简单解决方案可能是依靠MutItems.这已经是一个库提供的向量上的可变迭代器.因此,您可能只是使用它而不是您自己的自定义类型,或者您可以将其包装在自定义迭代器类型中.如果由于某种原因你不能这样做,你将不得不编写自己的不安全代码.如果你这样做,请确保

• 您不创建别名的multiplte可变引用.如果你这样做,这将违反Rust规则并调用未定义的behviour.
• 您不要忘记使用该PhantomData类型告诉编译器您的迭代器是类似于引用的类型,其中不允许使用较长的生命周期替换生命周期,否则可能会创建一个悬空迭代器.