Struct core::iter::Peekable

1.0.0 · source ·
pub struct Peekable<I: Iterator> { /* private fields */ }
Expand description

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

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

Implementations§

source§

impl<I: Iterator> Peekable<I>

source

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

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

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

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

Examples

基本用法:

let xs = [1, 2, 3];

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

// peek() 让我们能看到未来
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);
Run
1.53.0 · source

pub fn peek_mut(&mut self) -> Option<&mut I::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]);
Run
1.51.0 · source

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

如果条件为 true,则消费并返回此迭代器的下一个值。

如果 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));
Run

消费小于 10 的任何数字。

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

pub fn next_if_eq<T>(&mut self, expected: &T) -> Option<I::Item>where T: ?Sized, I::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));
Run

Trait Implementations§

source§

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

source§

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

返回值的副本。 Read more
source§

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

source 执行复制分配。 Read more
source§

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

source§

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

使用给定的格式化程序格式化该值。 Read more
1.38.0 · source§

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

source§

fn next_back(&mut self) -> Option<Self::Item>

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

fn try_rfold<B, F, R>(&mut self, init: B, f: F) -> Rwhere Self: Sized, F: FnMut(B, Self::Item) -> R, R: Try<Output = B>,

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

fn rfold<Acc, Fold>(self, init: Acc, fold: Fold) -> Accwhere Fold: FnMut(Acc, Self::Item) -> Acc,

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

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

🔬This is a nightly-only experimental API. (iter_advance_by #77404)
通过 n 元素从后向前推进迭代器。 Read more
1.37.0 · source§

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

从迭代器的末尾返回第 n 个元素。 Read more
1.27.0 · source§

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

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

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

source§

fn len(&self) -> usize

返回迭代器的确切剩余长度。 Read more
source§

fn is_empty(&self) -> bool

🔬This is a nightly-only experimental API. (exact_size_is_empty #35428)
如果迭代器为空,则返回 trueRead more
source§

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

§

type Item = <I as Iterator>::Item

被迭代的元素的类型。
source§

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

推进迭代器并返回下一个值。 Read more
source§

fn count(self) -> usize

消耗迭代器,计算迭代次数并返回它。 Read more
source§

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

返回迭代器的第 n 个元素。 Read more
source§

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

消耗迭代器,返回最后一个元素。 Read more
source§

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

返回迭代器剩余长度的界限。 Read more
source§

fn try_fold<B, F, R>(&mut self, init: B, f: F) -> Rwhere Self: Sized, F: FnMut(B, Self::Item) -> R, R: Try<Output = B>,

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

fn fold<Acc, Fold>(self, init: Acc, fold: Fold) -> Accwhere Fold: FnMut(Acc, Self::Item) -> Acc,

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

fn next_chunk<const N: usize>( &mut self ) -> Result<[Self::Item; N], IntoIter<Self::Item, N>>where Self: Sized,

🔬This is a nightly-only experimental API. (iter_next_chunk #98326)
推进迭代器并返回包含下一个 N 值的数组。 Read more
source§

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

🔬This is a nightly-only experimental API. (iter_advance_by #77404)
通过 n 元素使迭代器前进。 Read more
1.28.0 · source§

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

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

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

接受两个迭代器,并依次在两个迭代器上创建一个新的迭代器。 Read more
source§

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

将两个迭代器压缩为成对的单个迭代器。 Read more
source§

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

🔬This is a nightly-only experimental API. (iter_intersperse #79524)
创建一个新的迭代器,该迭代器将 separator 生成的项放在原始迭代器的相邻项之间。 Read more
source§

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

获取一个闭包并创建一个迭代器,该迭代器在每个元素上调用该闭包。 Read more
1.21.0 · source§

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

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

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

创建一个迭代器,该迭代器使用闭包确定是否应产生元素。 Read more
source§

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

创建一个同时过滤和映射的迭代器。 Read more
source§

fn enumerate(self) -> Enumerate<Self> where Self: Sized,

创建一个迭代器,该迭代器给出当前迭代次数以及下一个值。 Read more
source§

fn peekable(self) -> Peekable<Self> where Self: Sized,

创建一个迭代器,它可以使用 peekpeek_mut 方法查看迭代器的下一个元素而不消耗它。有关更多信息,请参见他们的文档。 Read more
source§

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

创建一个迭代器,该迭代器基于谓词 skip 元素。 Read more
source§

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

创建一个迭代器,该迭代器根据谓词产生元素。 Read more
1.57.0 · source§

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

创建一个迭代器,该迭代器均基于谓词和映射生成元素。 Read more
source§

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

创建一个跳过前 n 个元素的迭代器。 Read more
source§

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

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

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

一个迭代器适配器,它与 fold 一样保存内部状态,但与 fold 不同,它生成一个新的迭代器。 Read more
source§

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

创建一个迭代器,其工作方式类似于 map,但它会将嵌套的结构展平。 Read more
source§

fn fuse(self) -> Fuse<Self> where Self: Sized,

创建一个迭代器,该迭代器在第一个 None 之后结束。 Read more
source§

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

对迭代器的每个元素执行某些操作,将值传递给它。 Read more
source§

fn by_ref(&mut self) -> &mut Selfwhere Self: Sized,

借用一个迭代器,而不是使用它。 Read more
source§

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

将迭代器转换为集合。 Read more
source§

fn collect_into<E: Extend<Self::Item>>(self, collection: &mut E) -> &mut Ewhere Self: Sized,

🔬This is a nightly-only experimental API. (iter_collect_into #94780)
将迭代器中的所有项收集到一个集合中。 Read more
source§

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

消耗一个迭代器,从中创建两个集合。 Read more
source§

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

🔬This is a nightly-only experimental API. (iter_is_partitioned #62544)
检查此迭代器的元素是否根据给定的谓词进行了分区,以便所有返回 true 的元素都在所有返回 false 的元素之前。 Read more
1.27.0 · source§

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

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

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

通过重复应用缩减操作,将元素缩减为一个。 Read more
source§

fn try_reduce<F, R>( &mut self, f: F ) -> <<R as Try>::Residual as Residual<Option<R::Output>>>::TryTypewhere Self: Sized, F: FnMut(Self::Item, Self::Item) -> R, R: Try<Output = Self::Item>, R::Residual: Residual<Option<Self::Item>>,

🔬This is a nightly-only experimental API. (iterator_try_reduce #87053)
通过重复应用 Reduce 操作,将元素归约为单个元素。 如果闭包返回失败,则失败会立即传播给调用者。 Read more
source§

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

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

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

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

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

搜索满足谓词的迭代器的元素。 Read more
1.30.0 · source§

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

将函数应用于迭代器的元素,并返回第一个非 None 的结果。 Read more
source§

fn try_find<F, R>( &mut self, f: F ) -> <<R as Try>::Residual as Residual<Option<Self::Item>>>::TryTypewhere Self: Sized, F: FnMut(&Self::Item) -> R, R: Try<Output = bool>, R::Residual: Residual<Option<Self::Item>>,

🔬This is a nightly-only experimental API. (try_find #63178)
将函数应用于迭代器的元素,并返回第一个为 true 的结果或第一个错误。 Read more
source§

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

在迭代器中搜索元素,并返回其索引。 Read more
1.6.0 · source§

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

返回给出指定函数最大值的元素。 Read more
1.15.0 · source§

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

返回给出相对于指定比较函数的最大值的元素。 Read more
1.6.0 · source§

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

返回给出指定函数中最小值的元素。 Read more
1.15.0 · source§

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

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

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

将成对的迭代器转换为一对容器。 Read more
1.36.0 · source§

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

创建一个迭代器,该迭代器将复制其所有元素。 Read more
source§

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

创建一个迭代器,该迭代器将克隆所有元素。 Read more
source§

fn array_chunks<const N: usize>(self) -> ArrayChunks<Self, N> where Self: Sized,

🔬This is a nightly-only experimental API. (iter_array_chunks #100450)
一次返回迭代器的 N 个元素的迭代器。 Read more
1.11.0 · source§

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

对迭代器的元素求和。 Read more
1.11.0 · source§

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

遍历整个迭代器,将所有元素相乘 Read more
source§

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

🔬This is a nightly-only experimental API. (iter_order_by #64295)
字典顺序 根据指定的比较函数将这个 Iterator 的元素与另一个 Iterator 的元素进行比较。 Read more
1.5.0 · source§

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

Lexicographically 将此 IteratorPartialOrd 元素与另一个 PartialOrd 的元素进行比较。 比较的工作方式类似于短路评估,返回结果而不比较其余元素。 一旦可以确定订单,评估就会停止并返回结果。 Read more
source§

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

🔬This is a nightly-only experimental API. (iter_order_by #64295)
字典顺序 根据指定的比较函数将这个 Iterator 的元素与另一个 Iterator 的元素进行比较。 Read more
1.5.0 · source§

fn eq<I>(self, other: I) -> boolwhere I: IntoIterator, Self::Item: PartialEq<I::Item>, Self: Sized,

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

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

🔬This is a nightly-only experimental API. (iter_order_by #64295)
关于指定的相等函数,确定 Iterator 的元素是否与另一个元素相等。 Read more
1.5.0 · source§

fn ne<I>(self, other: I) -> boolwhere I: IntoIterator, Self::Item: PartialEq<I::Item>, Self: Sized,

确定此 Iterator 的元素是否不等于另一个的元素。 Read more
1.5.0 · source§

fn lt<I>(self, other: I) -> boolwhere I: IntoIterator, Self::Item: PartialOrd<I::Item>, Self: Sized,

确定此 Iterator 的元素是否比另一个元素少 按字典顺序Read more
1.5.0 · source§

fn le<I>(self, other: I) -> boolwhere I: IntoIterator, Self::Item: PartialOrd<I::Item>, Self: Sized,

确定此 Iterator 的元素是否 按字典顺序 小于或等于另一个元素。 Read more
1.5.0 · source§

fn gt<I>(self, other: I) -> boolwhere I: IntoIterator, Self::Item: PartialOrd<I::Item>, Self: Sized,

确定此 Iterator 的元素是否大于另一个元素的 按字典顺序Read more
1.5.0 · source§

fn ge<I>(self, other: I) -> boolwhere I: IntoIterator, Self::Item: PartialOrd<I::Item>, Self: Sized,

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

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

🔬This is a nightly-only experimental API. (is_sorted #53485)
检查此迭代器的元素是否使用给定的比较器函数进行排序。 Read more
source§

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

🔬This is a nightly-only experimental API. (is_sorted #53485)
检查此迭代器的元素是否使用给定的键提取函数进行排序。 Read more
1.26.0 · source§

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

source§

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

Auto Trait Implementations§

§

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

§

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

§

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

§

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

§

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

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

获取 selfTypeIdRead more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

从拥有的值中一成不变地借用。 Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

从拥有的值中借用。 Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

返回未更改的参数。

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

调用 U::from(self)

也就是说,这种转换是 From<T> for U 实现选择执行的任何操作。

source§

impl<I> IntoIterator for Iwhere I: Iterator,

§

type Item = <I as Iterator>::Item

被迭代的元素的类型。
§

type IntoIter = I

我们将其变成哪种迭代器?
const: unstable · source§

fn into_iter(self) -> I

从一个值创建一个迭代器。 Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

发生转换错误时返回的类型。
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

执行转换。
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

发生转换错误时返回的类型。
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

执行转换。