Rust Iterator迭代器-学习随笔

我认为熟记吃透Rust Option、Result、Iterator这3块的方法集，非常有助于写出简洁高效符合Rust Style的代码！原理性的东西好多前辈都讲过了，我就不啰嗦了！这三块的方法功用必须要记牢！我收集了几个常用方法的小例子，方便查询记忆而已。

• iter() => &T

• iter_mut() => &mut T

• into_iter() => T //不一定为T, 也可能是&T、&mut T ;由into_iter()调用者自身的引用方式决定。请看rust_iter/create_intoiterator2代码片段：

  本文代码例子都放在：https://github.com/yujinliang/rust_learn/tree/master/rust_iter

 

//IntoIterator trait 意思很直白，即是生成一个Iterator。
//move semantic
impl IntoIterator for Pixel {...} //T
//ref semantic 
impl<'a> IntoIterator for &'a Pixel {...} //&T
//ref mut semantic
impl<'a> IntoIterator for &'a mut Pixel {...}//&mut T

 

• 实现迭代器

详情请参考：https://doc.rust-lang.org/std/iter/trait.Iterator.html

只要实现Iterator Trait即可被遍历，官方文档给出的小例子，如下：

// First, the struct:
​
/// An iterator which counts from one to five
struct Counter {
    count: usize,
}
​
// we want our count to start at one, so let's add a new() method to help.
// This isn't strictly necessary, but is convenient. Note that we start
// `count` at zero, we'll see why in `next()`'s implementation below.
impl Counter {
    fn new() -> Counter {
        Counter { count: 0 }
    }
}
​
// Then, we implement `Iterator` for our `Counter`:
​
impl Iterator for Counter {
    // we will be counting with usize
    type Item = usize;
​
    // next() is the only required method
    fn next(&mut self) -> Option {
        // Increment our count. This is why we started at zero.
        self.count += 1;
​
        // Check to see if we've finished counting or not.
        if self.count < 6 {
            Some(self.count)
        } else {
            None
        }
    }
}
​
// And now we can use it!
​
let mut counter = Counter::new();
​
let x = counter.next().unwrap();
println!("{}", x);
​
let x = counter.next().unwrap();
println!("{}", x);
​
let x = counter.next().unwrap();
println!("{}", x);
​
let x = counter.next().unwrap();
println!("{}", x);
​
let x = counter.next().unwrap();
println!("{}", x);

 

• Trait IntoIterator for for loop

详情请参考：https://doc.rust-lang.org/std/iter/trait.IntoIterator.html

标准库容器，包括自定义类型，如果可以被for遍历，形如 for x in v ；for x in &v; for x in &mut v; 需要实现Trait IntoIterator，对于容器v不同的引用方式，直接决定最终生成的Iterator对于容器中元素的指向关系！

实现Trait IntoIterator, 只要调用其into_iter()方法就可以生成相应的迭代器Iterator ，有了容器的Iterator之后，for就可以遍历容器了！注意IntoIterator的名字很直白，就是变成一个对应的Iterator, 分为3种，如：T, &T, &mut T ，即对于容器中元素区分3种指向关系：拥有所有权、只读借用、可读可修改；

不限于for , 只要一个类型实现Trait IntoIterator, 那么调用into_iter()方法就可以获得相应的Iterator ! 形如：a_var.into_iter() 、 （&a_var).into_iter()、 (&mut a_var).into_iter() ， 从而生成相应的Iterator： 拥有所有权、只读引用、可读写引用。

【into_iter注意事项】

fn main() {
    let v = vec![1, 2, 3];
    let mut iter = v.into_iter(); //一旦调用into_iter, 则v的所有权被转移进iter, 后面语句若再访问v, 则编译报错。
    //(&v).into_iter() / (&mut v).into_iter() 可以避免v的所有权被move走。
    assert_eq!(Some(1), iter.next());
    assert_eq!(Some(2), iter.next());
    assert_eq!(Some(3), iter.next());
    assert_eq!(None, iter.next());
    //println!("{:#?}", v); //compilation error: ^ value borrowed here after move，v已经失去所有权，故此编译报错。
}

强调一下: move语义是所有Rust数据类型默认语义，而只有实现了std::marker::Copy trait 的类型，才会执行复制语义。 如基本数据类型：数字、字符、bool等都实现了Copy trait。

Rust借用检查规定： &mut 型借用是排他的！就像皇帝自称寡人， 独一无二 ，所以不允许有其他同时存在的&只读借用和&mut型借用，否则编译器报错！而&只读借用则放松的多，允许同时存在多个&只读借用。

所以这就导致实现IterMut就非常困难！甚至需要一些unsafe的方法！我收集了几个高手写的trick代码，确实麻烦！其中我尝试的例子rust_iter/create_intoiterator2 编译报错，没有跑通！难点就在报错处，需要一点hack trick可能才能通过！也有高手说如果Rust可以提供GAT（generic associated types ）特性， 那么实现mutual reference iterator的难点就解决了。

实现mutual reference iterator的难点：1. lifetime问题，随着引用传递链越来越长，lifetime越来越难以分析和表述！（Rust 借用原则铁律：引用的lifetime不得大于被引用者的lifetime！）2. &'a mut型可变引用具有排他性，必须独一无二！即被引用者被冻结，同时不允许其拥有其他引用！所以mutual reference iterator实现时必须保证&'a mut型引用的孤家寡人原则。第2点为主要难点！我学习https://rust-unofficial.github.io/too-many-lists/second-iter-mut.html， 采用Option及其take方法来破解第2难点， 终于可以跑通了！//虽然跑通了，但是因为self.pixel被take之后变为None了， 所以不能循环了， 只能输出第一个元素，总算前进了一大步！您也帮我研究一下吧rust_iter/create_intoiterator2

---

Rust迭代器及其各种方法的代码例子， 我推荐： https://github.com/rustomax/rust-iterators ， 讲解的简洁易懂！讲的真好！另一篇文章讲解得也相当好，推荐https://www.worthe-it.co.za/programming/2019/08/01/rust-iterators-cheatsheet.html ， 反复研读必有所获。

 

 

• Author

作者：心尘了

email: [email protected]

git：https://github.com/yujinliang/rust_learn

水平有限，笔记草乱，如有谬误，尽请指正！

 

• Reference

《深入浅出Rust》 ，范长春著，机械工业出版社

https://danielkeep.github.io/itercheat_baked.html

https://github.com/rustomax/rust-iterators

https://www.worthe-it.co.za/programming/2019/08/01/rust-iterators-cheatsheet.html

https://doc.rust-lang.org/std/iter/trait.IntoIterator.html

https://stackoverflow.com/questions/30218886/how-to-implement-iterator-and-intoiterator-for-a-simple-struct

https://rust-unofficial.github.io/too-many-lists/second-into-iter.html

https://stackoverflow.com/questions/61978903/how-do-i-create-mutable-iterator-over-struct-fields

https://play.rust-lang.org/?version=stable&mode=debug&edition=2018&gist=0a4985c71ce91c1ed956fdfee200ff67

https://play.rust-lang.org/?version=stable&mode=debug&edition=2018&gist=023ed8c692fc3159f4c43a9d12f5746e

https://play.rust-lang.org/?version=stable&mode=debug&edition=2018&gist=7ca09addf7c96ac4791c43f38cf1b61f

https://rust-unofficial.github.io/too-many-lists/second-iter-mut.html

https://github.com/rust-lang/rust/issues/44265

https://github.com/rust-lang/rfcs/pull/1598

https://doc.rust-lang.org/rust-by-example/generics/assoc_items/types.html

https://doc.rust-lang.org/book/ch10-03-lifetime-syntax.html#generic-lifetimes-in-functions

https://stackoverflow.com/questions/38089723/how-to-implement-an-iterator-of-mutable-references-to-the-values-in-the-right-ed

https://stackoverflow.com/questions/61847200/cannot-infer-an-appropriate-lifetime-for-autoref-due-to-conflicting-requirement