Struct std::iter::Peekable

#[must_use = "iterators are lazy and do nothing unless consumed"]
pub struct Peekable<I> where
    I: Iterator,  { /* fields omitted */ }

带有 peek() 的迭代器，该迭代器将可选的引用返回到下一个元素。

该 struct 是通过 Iterator 上的 peekable 方法创建的。 有关更多信息，请参见其文档。

Implementations

impl<I> Peekable<I> where
    I: Iterator, 

pub fn peek(&mut self) -> Option<&<I as Iterator>::Item>

在不推进迭代器的情况下，返回 next() 值的引用。

与 next 一样，如果有值，则将其包装在 Some(T) 中。 但是，如果迭代结束，则返回 None。

因为 peek() 返回一个引用，并且许多迭代器迭代引用，所以返回值是双引用的情况可能会令人困惑。 您可以在下面的示例中看到这种效果。

Examples

基本用法:

let xs = [1, 2, 3];

let mut iter = xs.iter().peekable();

// peek() 让我们看看 future
assert_eq!(iter.peek(), Some(&&1));
assert_eq!(iter.next(), Some(&1));

assert_eq!(iter.next(), Some(&2));

// 即使我们多次 `peek`，迭代器也不会前进
assert_eq!(iter.peek(), Some(&&3));
assert_eq!(iter.peek(), Some(&&3));

assert_eq!(iter.next(), Some(&3));

// 迭代器完成后，`peek()` 也是如此
assert_eq!(iter.peek(), None);
assert_eq!(iter.next(), None);

pub fn peek_mut(&mut self) -> Option<&mut <I as Iterator>::Item>

返回 next() 值的变量引用，而无需前进迭代器。

与 next 一样，如果有值，则将其包装在 Some(T) 中。 但是，如果迭代结束，则返回 None。

因为 peek_mut() 返回一个，并且许多迭代器迭代引用，所以返回值是双引用的情况可能会令人困惑。 您可以在下面的示例中看到这种效果。

Examples

基本用法:

let mut iter = [1, 2, 3].iter().peekable();

// 像 `peek()` 一样，我们可以在不推进迭代器的情况下查看 future。
assert_eq!(iter.peek_mut(), Some(&mut &1));
assert_eq!(iter.peek_mut(), Some(&mut &1));
assert_eq!(iter.next(), Some(&1));

// 查看迭代器并设置可变引用背后的值。
if let Some(p) = iter.peek_mut() {
    assert_eq!(*p, &2);
    *p = &5;
}

// 随着迭代器的继续，我们输入的值会重新出现。
assert_eq!(iter.collect::<Vec<_>>(), vec![&5, &3]);

pub fn next_if(
    &mut self,
    func: impl FnOnce(&<I as Iterator>::Item) -> bool
) -> Option<<I as Iterator>::Item>

如果条件为真，则使用并返回此迭代器的下一个值。

如果 func 返回 true 作为此迭代器的下一个值，请消耗并返回它。 否则，返回 None。

Examples

如果它等于 0，则使用一个数字。

let mut iter = (0..5).peekable();
// 迭代器的第一个项是 0; 消耗它。
assert_eq!(iter.next_if(|&x| x == 0), Some(0));
// 现在返回的下一个项为 1，因此 `consume` 将返回 `false`。
assert_eq!(iter.next_if(|&x| x == 0), None);
// `next_if` 如果下一个项目的值不等于 `expected`，则保存该值。
assert_eq!(iter.next(), Some(1));

消费小于 10 的任何数字。

let mut iter = (1..20).peekable();
// 消耗所有小于 10 的数字
while iter.next_if(|&x| x < 10).is_some() {}
// 返回的下一个值将是 10
assert_eq!(iter.next(), Some(10));

pub fn next_if_eq<T>(&mut self, expected: &T) -> Option<<I as Iterator>::Item> where
    T: ?Sized,
    <I as Iterator>::Item: PartialEq<T>, 

消费并返回下一个等于 expected 的项。

Example

如果它等于 0，则使用一个数字。

let mut iter = (0..5).peekable();
// 迭代器的第一个项是 0; 消耗它。
assert_eq!(iter.next_if_eq(&0), Some(0));
// 现在返回的下一个项为 1，因此 `consume` 将返回 `false`。
assert_eq!(iter.next_if_eq(&0), None);
// `next_if_eq` 如果下一个项目的值不等于 `expected`，则保存该值。
assert_eq!(iter.next(), Some(1));

Trait Implementations

impl<I> Clone for Peekable<I> where
    I: Clone + Iterator,
    <I as Iterator>::Item: Clone, 

pub fn clone(&self) -> Peekable<I>

返回值的副本。

fn clone_from(&mut self, source: &Self)

从 source 执行复制分配。

impl<I> Debug for Peekable<I> where
    I: Debug + Iterator,
    <I as Iterator>::Item: Debug, 

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

使用给定的格式化程序格式化该值。

impl<I> DoubleEndedIterator for Peekable<I> where
    I: DoubleEndedIterator, 

pub fn next_back(&mut self) -> Option<<Peekable<I> as Iterator>::Item>

从迭代器的末尾删除并返回一个元素。

pub fn try_rfold<B, F, R>(&mut self, init: B, f: F) -> R where
    F: FnMut(B, <Peekable<I> as Iterator>::Item) -> R,
    R: Try<Output = B>,
    Peekable<I>: Sized, 

这是 Iterator::try_fold() 的反向版本: 它从迭代器的后面开始接收元素。

pub fn rfold<Acc, Fold>(self, init: Acc, fold: Fold) -> Acc where
    Fold: FnMut(Acc, <Peekable<I> as Iterator>::Item) -> Acc, 

一种迭代器方法，从后面开始，将迭代器的元素减少为单个最终值。

fn advance_back_by(&mut self, n: usize) -> Result<(), usize>

🔬 This is a nightly-only experimental API. (iter_advance_by #77404)

recently added

通过 n 元素从后向前推进迭代器。

fn nth_back(&mut self, n: usize) -> Option<Self::Item>

从迭代器的末尾返回第 n 个元素。

fn rfind<P>(&mut self, predicate: P) -> Option<Self::Item> where
    P: FnMut(&Self::Item) -> bool, 

从后面搜索满足谓词的迭代器的元素。

impl<I> ExactSizeIterator for Peekable<I> where
    I: ExactSizeIterator, 

fn len(&self) -> usize

返回迭代器的确切长度。

fn is_empty(&self) -> bool

🔬 This is a nightly-only experimental API. (exact_size_is_empty #35428)

如果迭代器为空，则返回 true。

impl<I> Iterator for Peekable<I> where
    I: Iterator, 

type Item = <I as Iterator>::Item

被迭代的元素的类型。

pub fn next(&mut self) -> Option<<I as Iterator>::Item>

推进迭代器并返回下一个值。

pub fn count(self) -> usize

使用迭代器，计算迭代次数并返回它。

pub fn nth(&mut self, n: usize) -> Option<<I as Iterator>::Item>

返回迭代器的第 n 个元素。

pub fn last(self) -> Option<<I as Iterator>::Item>

使用迭代器，返回最后一个元素。

pub fn size_hint(&self) -> (usize, Option<usize>)

返回迭代器剩余长度的界限。

pub fn try_fold<B, F, R>(&mut self, init: B, f: F) -> R where
    F: FnMut(B, <Peekable<I> as Iterator>::Item) -> R,
    R: Try<Output = B>,
    Peekable<I>: Sized, 

一个迭代器方法，它只要成功返回就应用函数，并产生单个最终值。

pub fn fold<Acc, Fold>(self, init: Acc, fold: Fold) -> Acc where
    Fold: FnMut(Acc, <Peekable<I> as Iterator>::Item) -> Acc, 

通过应用操作将每个元素 fold 到一个累加器中，返回最终结果。

fn advance_by(&mut self, n: usize) -> Result<(), usize>

🔬 This is a nightly-only experimental API. (iter_advance_by #77404)

recently added

通过 n 元素使迭代器前进。

fn step_by(self, step: usize) -> StepBy<Self>

创建一个从同一点开始的迭代器，但在每次迭代时以给定的数量逐步执行。

fn chain<U>(self, other: U) -> Chain<Self, <U as IntoIterator>::IntoIter> where
    U: IntoIterator<Item = Self::Item>, 

接受两个迭代器，并依次在两个迭代器上创建一个新的迭代器。

fn zip<U>(self, other: U) -> Zip<Self, <U as IntoIterator>::IntoIter> where
    U: IntoIterator, 

将两个迭代器压缩为成对的单个迭代器。

fn intersperse(self, separator: Self::Item) -> Intersperse<Self> where
    Self::Item: Clone, 

🔬 This is a nightly-only experimental API. (iter_intersperse #79524)

recently added

创建一个新的迭代器，该迭代器将 separator 的副本放置在原始迭代器的相邻项之间。

fn intersperse_with<G>(self, separator: G) -> IntersperseWith<Self, G> where
    G: FnMut() -> Self::Item, 

🔬 This is a nightly-only experimental API. (iter_intersperse #79524)

recently added

创建一个新的迭代器，该迭代器将 separator 生成的项放在原始迭代器的相邻项之间。

fn map<B, F>(self, f: F) -> Map<Self, F> where
    F: FnMut(Self::Item) -> B, 

获取一个闭包并创建一个迭代器，该迭代器在每个元素上调用该闭包。

fn for_each<F>(self, f: F) where
    F: FnMut(Self::Item), 

在迭代器的每个元素上调用一个闭包。

fn filter<P>(self, predicate: P) -> Filter<Self, P> where
    P: FnMut(&Self::Item) -> bool, 

创建一个迭代器，该迭代器使用闭包确定是否应产生元素。

fn filter_map<B, F>(self, f: F) -> FilterMap<Self, F> where
    F: FnMut(Self::Item) -> Option<B>, 

创建一个同时过滤和 maps 的迭代器。

fn enumerate(self) -> Enumerate<Self>

创建一个迭代器，该迭代器给出当前迭代次数以及下一个值。

fn peekable(self) -> Peekable<Self>

创建一个迭代器，它可以使用 peek 和 peek_mut 方法查看迭代器的下一个元素而不消耗它。有关更多信息，请参见他们的文档。

fn skip_while<P>(self, predicate: P) -> SkipWhile<Self, P> where
    P: FnMut(&Self::Item) -> bool, 

创建一个迭代器，该迭代器基于谓词 skip 个元素。

fn take_while<P>(self, predicate: P) -> TakeWhile<Self, P> where
    P: FnMut(&Self::Item) -> bool, 

创建一个迭代器，该迭代器根据谓词产生元素。

fn map_while<B, P>(self, predicate: P) -> MapWhile<Self, P> where
    P: FnMut(Self::Item) -> Option<B>, 

🔬 This is a nightly-only experimental API. (iter_map_while #68537)

recently added

创建一个迭代器，该迭代器均基于谓词和 maps 产生元素。

fn skip(self, n: usize) -> Skip<Self>

创建一个跳过前 n 个元素的迭代器。

fn take(self, n: usize) -> Take<Self>

创建一个迭代器，它产生第一个 n 元素，如果底层迭代器提前结束，则产生更少的元素。

fn scan<St, B, F>(self, initial_state: St, f: F) -> Scan<Self, St, F> where
    F: FnMut(&mut St, Self::Item) -> Option<B>, 

与 fold 相似的迭代器适配器，它保持内部状态并生成新的迭代器。

fn flat_map<U, F>(self, f: F) -> FlatMap<Self, U, F> where
    F: FnMut(Self::Item) -> U,
    U: IntoIterator, 

创建一个迭代器，其工作方式类似于 map，但是将嵌套的结构展平。

fn flatten(self) -> Flatten<Self> where
    Self::Item: IntoIterator, 

创建一个可简化嵌套结构体的迭代器。

fn fuse(self) -> Fuse<Self>

创建一个迭代器，该迭代器在第一个 None 之后结束。

fn inspect<F>(self, f: F) -> Inspect<Self, F> where
    F: FnMut(&Self::Item), 

对迭代器的每个元素执行某些操作，将值传递给它。

fn by_ref(&mut self) -> &mut Self

借用一个迭代器，而不是使用它。

#[must_use = "if you really need to exhaust the iterator, consider `.for_each(drop)` instead"]

fn collect<B>(self) -> B where
    B: FromIterator<Self::Item>, 

将迭代器转换为集合。

fn partition<B, F>(self, f: F) -> (B, B) where
    F: FnMut(&Self::Item) -> bool,
    B: Default + Extend<Self::Item>, 

使用一个迭代器，从中创建两个集合。

fn partition_in_place<'a, T, P>(self, predicate: P) -> usize where
    Self: DoubleEndedIterator<Item = &'a mut T>,
    T: 'a,
    P: FnMut(&T) -> bool, 

🔬 This is a nightly-only experimental API. (iter_partition_in_place #62543)

new API

根据给定的谓词，对迭代器的元素进行就地重新排序，以使所有返回 true 的元素都在所有返回 false 的元素之前。 返回找到的 true 元素的数量。

fn is_partitioned<P>(self, predicate: P) -> bool where
    P: FnMut(Self::Item) -> bool, 

🔬 This is a nightly-only experimental API. (iter_is_partitioned #62544)

new API

检查此迭代器的元素是否根据给定的谓词进行了分区，以便所有返回 true 的元素都在所有返回 false 的元素之前。

fn try_for_each<F, R>(&mut self, f: F) -> R where
    F: FnMut(Self::Item) -> R,
    R: Try<Output = ()>, 

一个迭代器方法，该方法将一个容易犯错的函数应用于迭代器中的每个项，在第一个错误处停止并返回该错误。

fn reduce<F>(self, f: F) -> Option<Self::Item> where
    F: FnMut(Self::Item, Self::Item) -> Self::Item, 

通过重复应用归约运算，将元素缩减为一个。

fn all<F>(&mut self, f: F) -> bool where
    F: FnMut(Self::Item) -> bool, 

测试迭代器的每个元素是否与谓词匹配。

fn any<F>(&mut self, f: F) -> bool where
    F: FnMut(Self::Item) -> bool, 

测试迭代器的任何元素是否与谓词匹配。

fn find<P>(&mut self, predicate: P) -> Option<Self::Item> where
    P: FnMut(&Self::Item) -> bool, 

搜索满足谓词的迭代器的元素。

fn find_map<B, F>(&mut self, f: F) -> Option<B> where
    F: FnMut(Self::Item) -> Option<B>, 

将函数应用于迭代器的元素，并返回第一个非无结果。

fn try_find<F, R, E>(&mut self, f: F) -> Result<Option<Self::Item>, E> where
    F: FnMut(&Self::Item) -> R,
    R: Try<Output = bool, Residual = Result<Infallible, E>> + Try, 

🔬 This is a nightly-only experimental API. (try_find #63178)

new API

将函数应用于迭代器的元素，并返回第一个真结果或第一个错误。

fn position<P>(&mut self, predicate: P) -> Option<usize> where
    P: FnMut(Self::Item) -> bool, 

在迭代器中搜索元素，并返回其索引。

fn rposition<P>(&mut self, predicate: P) -> Option<usize> where
    Self: ExactSizeIterator + DoubleEndedIterator,
    P: FnMut(Self::Item) -> bool, 

从右侧搜索迭代器中的元素，并返回其索引。

fn max(self) -> Option<Self::Item> where
    Self::Item: Ord, 

返回迭代器的最大元素。

fn min(self) -> Option<Self::Item> where
    Self::Item: Ord, 

返回迭代器的最小元素。

fn max_by_key<B, F>(self, f: F) -> Option<Self::Item> where
    F: FnMut(&Self::Item) -> B,
    B: Ord, 

返回给出指定函数最大值的元素。

fn max_by<F>(self, compare: F) -> Option<Self::Item> where
    F: FnMut(&Self::Item, &Self::Item) -> Ordering, 

返回给出相对于指定比较函数的最大值的元素。

fn min_by_key<B, F>(self, f: F) -> Option<Self::Item> where
    F: FnMut(&Self::Item) -> B,
    B: Ord, 

返回给出指定函数中最小值的元素。

fn min_by<F>(self, compare: F) -> Option<Self::Item> where
    F: FnMut(&Self::Item, &Self::Item) -> Ordering, 

返回给出相对于指定比较函数的最小值的元素。

fn rev(self) -> Rev<Self> where
    Self: DoubleEndedIterator, 

反转迭代器的方向。

fn unzip<A, B, FromA, FromB>(self) -> (FromA, FromB) where
    Self: Iterator<Item = (A, B)>,
    FromA: Default + Extend<A>,
    FromB: Default + Extend<B>, 

将成对的迭代器转换为一对容器。

fn copied<'a, T>(self) -> Copied<Self> where
    Self: Iterator<Item = &'a T>,
    T: 'a + Copy, 

创建一个迭代器，该迭代器将复制其所有元素。

fn cloned<'a, T>(self) -> Cloned<Self> where
    Self: Iterator<Item = &'a T>,
    T: 'a + Clone, 

创建一个迭代器，该迭代器将克隆所有元素。

fn cycle(self) -> Cycle<Self> where
    Self: Clone, 

不断重复的迭代器。

fn sum<S>(self) -> S where
    S: Sum<Self::Item>, 

对迭代器的元素求和。

fn product<P>(self) -> P where
    P: Product<Self::Item>, 

遍历整个迭代器，将所有元素相乘

fn cmp<I>(self, other: I) -> Ordering where
    I: IntoIterator<Item = Self::Item>,
    Self::Item: Ord, 

Lexicographically 将此 Iterator 的元素与另一个元素进行比较。

fn cmp_by<I, F>(self, other: I, cmp: F) -> Ordering where
    F: FnMut(Self::Item, <I as IntoIterator>::Item) -> Ordering,
    I: IntoIterator, 

🔬 This is a nightly-only experimental API. (iter_order_by #64295)

Lexicographically 就指定的比较函数而言，将此 Iterator 的元素与另一个元素进行比较。

fn partial_cmp<I>(self, other: I) -> Option<Ordering> where
    I: IntoIterator,
    Self::Item: PartialOrd<<I as IntoIterator>::Item>, 

Lexicographically 将此 Iterator 的元素与另一个元素进行比较。

fn partial_cmp_by<I, F>(self, other: I, partial_cmp: F) -> Option<Ordering> where
    F: FnMut(Self::Item, <I as IntoIterator>::Item) -> Option<Ordering>,
    I: IntoIterator, 

🔬 This is a nightly-only experimental API. (iter_order_by #64295)

Lexicographically 就指定的比较函数而言，将此 Iterator 的元素与另一个元素进行比较。

fn eq<I>(self, other: I) -> bool where
    I: IntoIterator,
    Self::Item: PartialEq<<I as IntoIterator>::Item>, 

确定此 Iterator 的元素是否与另一个元素相同。

fn eq_by<I, F>(self, other: I, eq: F) -> bool where
    F: FnMut(Self::Item, <I as IntoIterator>::Item) -> bool,
    I: IntoIterator, 

🔬 This is a nightly-only experimental API. (iter_order_by #64295)

关于指定的相等函数，确定 Iterator 的元素是否与另一个元素相等。

fn ne<I>(self, other: I) -> bool where
    I: IntoIterator,
    Self::Item: PartialEq<<I as IntoIterator>::Item>, 

确定此 Iterator 的元素是否与另一个元素不相等。

fn lt<I>(self, other: I) -> bool where
    I: IntoIterator,
    Self::Item: PartialOrd<<I as IntoIterator>::Item>, 

确定此 Iterator 的元素是否比另一个元素少 按字典顺序。

fn le<I>(self, other: I) -> bool where
    I: IntoIterator,
    Self::Item: PartialOrd<<I as IntoIterator>::Item>, 

确定此 Iterator 的元素是否 按字典顺序 小于或等于另一个元素。

fn gt<I>(self, other: I) -> bool where
    I: IntoIterator,
    Self::Item: PartialOrd<<I as IntoIterator>::Item>, 

确定此 Iterator 的元素是否大于另一个元素的 按字典顺序。

fn ge<I>(self, other: I) -> bool where
    I: IntoIterator,
    Self::Item: PartialOrd<<I as IntoIterator>::Item>, 

确定此 Iterator 的元素是否 按字典顺序 大于或等于另一个元素。

fn is_sorted(self) -> bool where
    Self::Item: PartialOrd<Self::Item>, 

🔬 This is a nightly-only experimental API. (is_sorted #53485)

new API

检查此迭代器的元素是否已排序。

fn is_sorted_by<F>(self, compare: F) -> bool where
    F: FnMut(&Self::Item, &Self::Item) -> Option<Ordering>, 

🔬 This is a nightly-only experimental API. (is_sorted #53485)

new API

检查此迭代器的元素是否使用给定的比较器函数进行排序。

fn is_sorted_by_key<F, K>(self, f: F) -> bool where
    F: FnMut(Self::Item) -> K,
    K: PartialOrd<K>, 

🔬 This is a nightly-only experimental API. (is_sorted #53485)

new API

检查此迭代器的元素是否使用给定的键提取函数进行排序。

impl<I> FusedIterator for Peekable<I> where
    I: FusedIterator, 

impl<I> TrustedLen for Peekable<I> where
    I: TrustedLen,