rust 如何编写一个迭代器来返回对自身的引用?

ehxuflar  于 2023-01-02  发布在  其他
关注(0)|答案(4)|浏览(253)

我在表达一个Iterator实现的返回值的生命周期时遇到了麻烦。我如何在不改变迭代器的返回值的情况下编译这段代码?我希望它返回一个引用向量。
很明显,我没有正确地使用寿命参数,但是在尝试了各种方法之后,我放弃了,我不知道该怎么处理它。

use std::iter::Iterator;

struct PermutationIterator<T> {
    vs: Vec<Vec<T>>,
    is: Vec<usize>,
}

impl<T> PermutationIterator<T> {
    fn new() -> PermutationIterator<T> {
        PermutationIterator {
            vs: vec![],
            is: vec![],
        }
    }

    fn add(&mut self, v: Vec<T>) {
        self.vs.push(v);
        self.is.push(0);
    }
}

impl<T> Iterator for PermutationIterator<T> {
    type Item = Vec<&'a T>;
    fn next(&mut self) -> Option<Vec<&T>> {
        'outer: loop {
            for i in 0..self.vs.len() {
                if self.is[i] >= self.vs[i].len() {
                    if i == 0 {
                        return None; // we are done
                    }
                    self.is[i] = 0;
                    self.is[i - 1] += 1;
                    continue 'outer;
                }
            }

            let mut result = vec![];

            for i in 0..self.vs.len() {
                let index = self.is[i];
                result.push(self.vs[i].get(index).unwrap());
            }

            *self.is.last_mut().unwrap() += 1;

            return Some(result);
        }
    }
}

fn main() {
    let v1: Vec<_> = (1..3).collect();
    let v2: Vec<_> = (3..5).collect();
    let v3: Vec<_> = (1..6).collect();

    let mut i = PermutationIterator::new();
    i.add(v1);
    i.add(v2);
    i.add(v3);

    loop {
        match i.next() {
            Some(v) => {
                println!("{:?}", v);
            }
            None => {
                break;
            }
        }
    }
}

Playground link

error[E0261]: use of undeclared lifetime name `'a`
  --> src/main.rs:23:22
   |
23 |     type Item = Vec<&'a T>;
   |                      ^^ undeclared lifetime
whitzsjs

whitzsjs1#

据我所知,你希望迭代器返回一个指向自身的引用向量,对吗?不幸的是,这在Rust中是不可能的。
这是Iterator的特征:

trait Iterator {
    type Item;
    fn next(&mut self) -> Option<Item>;
}

注意,&mut selfOption<Item>之间 * 没有生存期连接 *,这意味着next()方法不能将引用返回到迭代器本身,你只是不能表达返回引用的生存期,这基本上就是你找不到一种方法来指定正确的生存期的原因--它看起来像这样:

fn next<'a>(&'a mut self) -> Option<Vec<&'a T>>

除了这不是用于Iterator特征的有效next()方法。
这样的迭代器(可以返回引用到自身的迭代器)称为 *streaming iterator *,如果需要,可以找到更多的hereherehere

**Update.**然而,你可以从迭代器中返回一个对其他结构的引用--这是大多数集合迭代器的工作方式。

pub struct PermutationIterator<'a, T> {
    vs: &'a [Vec<T>],
    is: Vec<usize>
}

impl<'a, T> Iterator for PermutationIterator<'a, T> {
    type Item = Vec<&'a T>;

    fn next(&mut self) -> Option<Vec<&'a T>> {
        ...
    }
}

注意'a是如何在impl块上声明的。这样做是可以的(事实上是必需的),因为你需要在结构上指定lifetime参数。然后你可以在Itemnext()返回类型中使用相同的'a。同样,这是大多数集合迭代器的工作方式。

1dkrff03

1dkrff032#

@VladimirMatveev的答案是正确的,它解释了为什么你的代码不能编译。简单地说,它说迭代器不能从它自己内部产生借来的值。
但是,它可以从其他东西中获得借用值,这就是VecIter所实现的功能:Vec拥有这些值,而Iter只是一个能够在Vec中产生引用的 Package 器。
这里有一个设计可以达到你的目的,迭代器就像VecIter一样,只是一个 Package 器, Package 了实际拥有值的其他容器。

use std::iter::Iterator;

struct PermutationIterator<'a, T: 'a> {
    vs : Vec<&'a [T]>,
    is : Vec<usize>
}

impl<'a, T> PermutationIterator<'a, T> {
    fn new() -> PermutationIterator<'a, T> { ... }

    fn add(&mut self, v : &'a [T]) { ... }
}

impl<'a, T> Iterator for PermutationIterator<'a, T> {
    type Item = Vec<&'a T>;
    fn next(&mut self) -> Option<Vec<&'a T>> { ... }
}

fn main() {
    let v1 : Vec<i32> = (1..3).collect();
    let v2 : Vec<i32> = (3..5).collect();
    let v3 : Vec<i32> = (1..6).collect();

    let mut i = PermutationIterator::new();
    i.add(&v1);
    i.add(&v2);
    i.add(&v3);

    loop {
        match i.next() {
            Some(v) => { println!("{:?}", v); }
            None => {break;}
        }
    }
}

(Playground)
与您最初的问题无关。如果只是我,我会确保所有借用的向量都被一次获取。其思想是删除对add的重复调用,并在构造时直接传递所有借用的向量:

use std::iter::{Iterator, repeat};

struct PermutationIterator<'a, T: 'a> {
    ...
}

impl<'a, T> PermutationIterator<'a, T> {
    fn new(vs: Vec<&'a [T]>) -> PermutationIterator<'a, T> {
        let n = vs.len();
        PermutationIterator {
            vs: vs,
            is: repeat(0).take(n).collect(),
        }
    }
}

impl<'a, T> Iterator for PermutationIterator<'a, T> {
    ...
}

fn main() {
    let v1 : Vec<i32> = (1..3).collect();
    let v2 : Vec<i32> = (3..5).collect();
    let v3 : Vec<i32> = (1..6).collect();
    let vall: Vec<&[i32]> = vec![&v1, &v2, &v3];

    let mut i = PermutationIterator::new(vall);
}

(Playground)
EDIT:已更改迭代器设计,以采用Vec<&'a [T]>而不是Vec<Vec<&'a T>>。采用容器引用比构建引用容器更容易。)

xe55xuns

xe55xuns3#

正如在其他答案中提到的,这被称为 streaming iterator,它需要与Rust的Iterator不同的保证。一个提供这种功能的机箱被恰当地称为streaming-iterator,它提供StreamingIterator特性。
下面是一个实现trait的例子:

extern crate streaming_iterator;

use streaming_iterator::StreamingIterator;

struct Demonstration {
    scores: Vec<i32>,
    position: usize,
}

// Since `StreamingIterator` requires that we be able to call
// `advance` before `get`, we have to start "before" the first
// element. We assume that there will never be the maximum number of
// entries in the `Vec`, so we use `usize::MAX` as our sentinel value.
impl Demonstration {
    fn new() -> Self {
        Demonstration {
            scores: vec![1, 2, 3],
            position: std::usize::MAX,
        }
    }

    fn reset(&mut self) {
        self.position = std::usize::MAX;
    }
}

impl StreamingIterator for Demonstration {
    type Item = i32;

    fn advance(&mut self) {
        self.position = self.position.wrapping_add(1);
    }

    fn get(&self) -> Option<&Self::Item> {
        self.scores.get(self.position)
    }
}

fn main() {
    let mut example = Demonstration::new();

    loop {
        example.advance();
        match example.get() {
            Some(v) => {
                println!("v: {}", v);
            }
            None => break,
        }
    }

    example.reset();

    loop {
        example.advance();
        match example.get() {
            Some(v) => {
                println!("v: {}", v);
            }
            None => break,
        }
    }
}

不幸的是,流迭代器将受到限制,直到RFC 1598中的generic associated types (GATs)被实现。

wyyhbhjk

wyyhbhjk4#

不久前我写了这段代码,不知怎么的,我在这里偶然发现了这个问题,它做的正是这个问题所问的:它展示了如何实现一个迭代器来传递一个对自身的引用。
它为IntoIterator示例添加了一个.iter_map()方法,最初我认为应该为Iterator本身实现它,但这是一个不太灵活的设计决策。
我为它创建了一个小板条箱,并将我的代码发布到GitHub上,以防您想尝试它,您可以使用can find it here
虽然OP在为项目定义生命周期时遇到了麻烦,但在依赖默认的省略生命周期时,我在实现这一点时没有遇到任何这样的麻烦。
下面是一个用法的例子,注意回调函数接收的参数是迭代器本身,回调函数需要从迭代器中提取数据,然后直接传递或者执行其他操作。

use iter_map::IntoIterMap;

 let mut b = true;

 let s = "hello world!".chars().peekable().iter_map(|iter| {
     if let Some(&ch) = iter.peek() {
         if ch == 'o' && b {
             b = false;
             Some('0')
         } else {
             b = true;
             iter.next()
         }
     } else { None }
 }).collect::<String>();

 assert_eq!(&s, "hell0o w0orld!");

因为IntoIterMap泛型trait是为IntoIterator实现的,所以你可以从任何支持该接口的东西中得到一个“iter map”,例如,可以直接从一个数组中创建一个,如下所示:

use iter_map::*;

fn main() 
{
    let mut i = 0;

    let v = [1, 2, 3, 4, 5, 6].iter_map(move |iter| {
        i += 1;
        if i % 3 == 0 {
            Some(0)
        } else {
            iter.next().copied()
        }
    }).collect::<Vec<_>>();
 
    assert_eq!(v, vec![1, 2, 0, 3, 4, 0, 5, 6, 0]);
}

这是完整的代码--令人惊讶的是,它只需要这么少的代码就可以实现,而且所有的东西在组合起来的时候都运行得很顺利。这让我对Rust本身的灵活性和它的设计决策有了新的认识。

/// Adds `.iter_map()` method to all IntoIterator classes.
///
impl<F, I, J, R, T> IntoIterMap<F, I, R, T> for J
//
where F: FnMut(&mut I) -> Option<R>,
      I: Iterator<Item = T>,
      J: IntoIterator<Item = T, IntoIter = I>,
{
    /// Returns an iterator that invokes the callback in `.next()`, passing it
    /// the original iterator as an argument. The callback can return any
    /// arbitrary type within an `Option`.
    ///
    fn iter_map(self, callback: F) -> ParamFromFnIter<F, I>
    {
        ParamFromFnIter::new(self.into_iter(), callback)
    }
}

/// A trait to add the `.iter_map()` method to any existing class.
///
pub trait IntoIterMap<F, I, R, T>
//
where F: FnMut(&mut I) -> Option<R>,
      I: Iterator<Item = T>,
{
    /// Returns a `ParamFromFnIter` iterator which wraps the iterator it's 
    /// invoked on.
    ///
    /// # Arguments
    /// * `callback`  - The callback that gets invoked by `.next()`.
    ///                 This callback is passed the original iterator as its
    ///                 parameter.
    ///
    fn iter_map(self, callback: F) -> ParamFromFnIter<F, I>;
}

/// Implements an iterator that can be created from a callback.
/// does pretty much the same thing as `std::iter::from_fn()` except the 
/// callback signature of this class takes a data argument.
pub struct ParamFromFnIter<F, D>
{
    callback: F,
    data: D,
}

impl<F, D, R> ParamFromFnIter<F, D>
//
where F: FnMut(&mut D) -> Option<R>,
{
    /// Creates a new `ParamFromFnIter` iterator instance.
    ///
    /// This provides a flexible and simple way to create new iterators by 
    /// defining a callback. 
    /// # Arguments
    /// * `data`      - Data that will be passed to the callback on each 
    ///                 invocation.
    /// * `callback`  - The callback that gets invoked when `.next()` is invoked
    ///                 on the returned iterator.
    ///    
    pub fn new(data: D, callback: F) -> Self
    {
        ParamFromFnIter { callback, data }
    }
}

/// Implements Iterator for ParamFromFnIter. 
///
impl<F, D, R> Iterator for ParamFromFnIter<F, D>
//
where F: FnMut(&mut D) -> Option<R>,
{
    type Item = R;
    
    /// Iterator method that returns the next item.
    /// Invokes the client code provided iterator, passing it `&mut self.data`.
    ///
    fn next(&mut self) -> Option<Self::Item>
    {
        (self.callback)(&mut self.data)
    }
}

相关问题