1 // ignore-tidy-filelength
2 // This file almost exclusively consists of the definition of `Iterator`. We
3 // can't split that into multiple files.
5 use crate::cmp::{self, Ordering};
6 use crate::ops::{Add, ControlFlow, Try};
8 use super::super::TrustedRandomAccess;
9 use super::super::{Chain, Cloned, Copied, Cycle, Enumerate, Filter, FilterMap, Fuse};
10 use super::super::{FlatMap, Flatten};
11 use super::super::{FromIterator, Intersperse, Product, Sum, Zip};
13 Inspect, Map, MapWhile, Peekable, Rev, Scan, Skip, SkipWhile, StepBy, Take, TakeWhile,
16 fn _assert_is_object_safe(_: &dyn Iterator<Item = ()>) {}
18 /// An interface for dealing with iterators.
20 /// This is the main iterator trait. For more about the concept of iterators
21 /// generally, please see the [module-level documentation]. In particular, you
22 /// may want to know how to [implement `Iterator`][impl].
24 /// [module-level documentation]: crate::iter
25 /// [impl]: crate::iter#implementing-iterator
26 #[stable(feature = "rust1", since = "1.0.0")]
27 #[rustc_on_unimplemented(
29 _Self = "[std::ops::Range<Idx>; 1]",
30 label = "if you meant to iterate between two values, remove the square brackets",
31 note = "`[start..end]` is an array of one `Range`; you might have meant to have a `Range` \
32 without the brackets: `start..end`"
35 _Self = "[std::ops::RangeFrom<Idx>; 1]",
36 label = "if you meant to iterate from a value onwards, remove the square brackets",
37 note = "`[start..]` is an array of one `RangeFrom`; you might have meant to have a \
38 `RangeFrom` without the brackets: `start..`, keeping in mind that iterating over an \
39 unbounded iterator will run forever unless you `break` or `return` from within the \
43 _Self = "[std::ops::RangeTo<Idx>; 1]",
44 label = "if you meant to iterate until a value, remove the square brackets and add a \
46 note = "`[..end]` is an array of one `RangeTo`; you might have meant to have a bounded \
47 `Range` without the brackets: `0..end`"
50 _Self = "[std::ops::RangeInclusive<Idx>; 1]",
51 label = "if you meant to iterate between two values, remove the square brackets",
52 note = "`[start..=end]` is an array of one `RangeInclusive`; you might have meant to have a \
53 `RangeInclusive` without the brackets: `start..=end`"
56 _Self = "[std::ops::RangeToInclusive<Idx>; 1]",
57 label = "if you meant to iterate until a value (including it), remove the square brackets \
58 and add a starting value",
59 note = "`[..=end]` is an array of one `RangeToInclusive`; you might have meant to have a \
60 bounded `RangeInclusive` without the brackets: `0..=end`"
63 _Self = "std::ops::RangeTo<Idx>",
64 label = "if you meant to iterate until a value, add a starting value",
65 note = "`..end` is a `RangeTo`, which cannot be iterated on; you might have meant to have a \
66 bounded `Range`: `0..end`"
69 _Self = "std::ops::RangeToInclusive<Idx>",
70 label = "if you meant to iterate until a value (including it), add a starting value",
71 note = "`..=end` is a `RangeToInclusive`, which cannot be iterated on; you might have meant \
72 to have a bounded `RangeInclusive`: `0..=end`"
76 label = "`{Self}` is not an iterator; try calling `.chars()` or `.bytes()`"
79 _Self = "std::string::String",
80 label = "`{Self}` is not an iterator; try calling `.chars()` or `.bytes()`"
84 label = "borrow the array with `&` or call `.iter()` on it to iterate over it",
85 note = "arrays are not iterators, but slices like the following are: `&[1, 2, 3]`"
89 note = "if you want to iterate between `start` until a value `end`, use the exclusive range \
90 syntax `start..end` or the inclusive range syntax `start..=end`"
92 label = "`{Self}` is not an iterator",
93 message = "`{Self}` is not an iterator"
96 #[must_use = "iterators are lazy and do nothing unless consumed"]
98 /// The type of the elements being iterated over.
99 #[stable(feature = "rust1", since = "1.0.0")]
102 /// Advances the iterator and returns the next value.
104 /// Returns [`None`] when iteration is finished. Individual iterator
105 /// implementations may choose to resume iteration, and so calling `next()`
106 /// again may or may not eventually start returning [`Some(Item)`] again at some
109 /// [`Some(Item)`]: Some
116 /// let a = [1, 2, 3];
118 /// let mut iter = a.iter();
120 /// // A call to next() returns the next value...
121 /// assert_eq!(Some(&1), iter.next());
122 /// assert_eq!(Some(&2), iter.next());
123 /// assert_eq!(Some(&3), iter.next());
125 /// // ... and then None once it's over.
126 /// assert_eq!(None, iter.next());
128 /// // More calls may or may not return `None`. Here, they always will.
129 /// assert_eq!(None, iter.next());
130 /// assert_eq!(None, iter.next());
133 #[stable(feature = "rust1", since = "1.0.0")]
134 fn next(&mut self) -> Option<Self::Item>;
136 /// Returns the bounds on the remaining length of the iterator.
138 /// Specifically, `size_hint()` returns a tuple where the first element
139 /// is the lower bound, and the second element is the upper bound.
141 /// The second half of the tuple that is returned is an [`Option`]`<`[`usize`]`>`.
142 /// A [`None`] here means that either there is no known upper bound, or the
143 /// upper bound is larger than [`usize`].
145 /// # Implementation notes
147 /// It is not enforced that an iterator implementation yields the declared
148 /// number of elements. A buggy iterator may yield less than the lower bound
149 /// or more than the upper bound of elements.
151 /// `size_hint()` is primarily intended to be used for optimizations such as
152 /// reserving space for the elements of the iterator, but must not be
153 /// trusted to e.g., omit bounds checks in unsafe code. An incorrect
154 /// implementation of `size_hint()` should not lead to memory safety
157 /// That said, the implementation should provide a correct estimation,
158 /// because otherwise it would be a violation of the trait's protocol.
160 /// The default implementation returns `(0, `[`None`]`)` which is correct for any
163 /// [`usize`]: type@usize
170 /// let a = [1, 2, 3];
171 /// let iter = a.iter();
173 /// assert_eq!((3, Some(3)), iter.size_hint());
176 /// A more complex example:
179 /// // The even numbers from zero to ten.
180 /// let iter = (0..10).filter(|x| x % 2 == 0);
182 /// // We might iterate from zero to ten times. Knowing that it's five
183 /// // exactly wouldn't be possible without executing filter().
184 /// assert_eq!((0, Some(10)), iter.size_hint());
186 /// // Let's add five more numbers with chain()
187 /// let iter = (0..10).filter(|x| x % 2 == 0).chain(15..20);
189 /// // now both bounds are increased by five
190 /// assert_eq!((5, Some(15)), iter.size_hint());
193 /// Returning `None` for an upper bound:
196 /// // an infinite iterator has no upper bound
197 /// // and the maximum possible lower bound
200 /// assert_eq!((usize::MAX, None), iter.size_hint());
203 #[stable(feature = "rust1", since = "1.0.0")]
204 fn size_hint(&self) -> (usize, Option<usize>) {
208 /// Consumes the iterator, counting the number of iterations and returning it.
210 /// This method will call [`next`] repeatedly until [`None`] is encountered,
211 /// returning the number of times it saw [`Some`]. Note that [`next`] has to be
212 /// called at least once even if the iterator does not have any elements.
214 /// [`next`]: Iterator::next
216 /// # Overflow Behavior
218 /// The method does no guarding against overflows, so counting elements of
219 /// an iterator with more than [`usize::MAX`] elements either produces the
220 /// wrong result or panics. If debug assertions are enabled, a panic is
225 /// This function might panic if the iterator has more than [`usize::MAX`]
228 /// [`usize::MAX`]: crate::usize::MAX
235 /// let a = [1, 2, 3];
236 /// assert_eq!(a.iter().count(), 3);
238 /// let a = [1, 2, 3, 4, 5];
239 /// assert_eq!(a.iter().count(), 5);
242 #[stable(feature = "rust1", since = "1.0.0")]
243 fn count(self) -> usize
248 fn add1<T>(count: usize, _: T) -> usize {
256 /// Consumes the iterator, returning the last element.
258 /// This method will evaluate the iterator until it returns [`None`]. While
259 /// doing so, it keeps track of the current element. After [`None`] is
260 /// returned, `last()` will then return the last element it saw.
267 /// let a = [1, 2, 3];
268 /// assert_eq!(a.iter().last(), Some(&3));
270 /// let a = [1, 2, 3, 4, 5];
271 /// assert_eq!(a.iter().last(), Some(&5));
274 #[stable(feature = "rust1", since = "1.0.0")]
275 fn last(self) -> Option<Self::Item>
280 fn some<T>(_: Option<T>, x: T) -> Option<T> {
284 self.fold(None, some)
287 /// Advances the iterator by `n` elements.
289 /// This method will eagerly skip `n` elements by calling [`next`] up to `n`
290 /// times until [`None`] is encountered.
292 /// `advance_by(n)` will return [`Ok(())`][Ok] if the iterator successfully advances by
293 /// `n` elements, or [`Err(k)`][Err] if [`None`] is encountered, where `k` is the number
294 /// of elements the iterator is advanced by before running out of elements (i.e. the
295 /// length of the iterator). Note that `k` is always less than `n`.
297 /// Calling `advance_by(0)` does not consume any elements and always returns [`Ok(())`][Ok].
299 /// [`next`]: Iterator::next
306 /// #![feature(iter_advance_by)]
308 /// let a = [1, 2, 3, 4];
309 /// let mut iter = a.iter();
311 /// assert_eq!(iter.advance_by(2), Ok(()));
312 /// assert_eq!(iter.next(), Some(&3));
313 /// assert_eq!(iter.advance_by(0), Ok(()));
314 /// assert_eq!(iter.advance_by(100), Err(1)); // only `&4` was skipped
317 #[unstable(feature = "iter_advance_by", reason = "recently added", issue = "77404")]
318 fn advance_by(&mut self, n: usize) -> Result<(), usize> {
320 self.next().ok_or(i)?;
325 /// Returns the `n`th element of the iterator.
327 /// Like most indexing operations, the count starts from zero, so `nth(0)`
328 /// returns the first value, `nth(1)` the second, and so on.
330 /// Note that all preceding elements, as well as the returned element, will be
331 /// consumed from the iterator. That means that the preceding elements will be
332 /// discarded, and also that calling `nth(0)` multiple times on the same iterator
333 /// will return different elements.
335 /// `nth()` will return [`None`] if `n` is greater than or equal to the length of the
343 /// let a = [1, 2, 3];
344 /// assert_eq!(a.iter().nth(1), Some(&2));
347 /// Calling `nth()` multiple times doesn't rewind the iterator:
350 /// let a = [1, 2, 3];
352 /// let mut iter = a.iter();
354 /// assert_eq!(iter.nth(1), Some(&2));
355 /// assert_eq!(iter.nth(1), None);
358 /// Returning `None` if there are less than `n + 1` elements:
361 /// let a = [1, 2, 3];
362 /// assert_eq!(a.iter().nth(10), None);
365 #[stable(feature = "rust1", since = "1.0.0")]
366 fn nth(&mut self, n: usize) -> Option<Self::Item> {
367 self.advance_by(n).ok()?;
371 /// Creates an iterator starting at the same point, but stepping by
372 /// the given amount at each iteration.
374 /// Note 1: The first element of the iterator will always be returned,
375 /// regardless of the step given.
377 /// Note 2: The time at which ignored elements are pulled is not fixed.
378 /// `StepBy` behaves like the sequence `next(), nth(step-1), nth(step-1), …`,
379 /// but is also free to behave like the sequence
380 /// `advance_n_and_return_first(step), advance_n_and_return_first(step), …`
381 /// Which way is used may change for some iterators for performance reasons.
382 /// The second way will advance the iterator earlier and may consume more items.
384 /// `advance_n_and_return_first` is the equivalent of:
386 /// fn advance_n_and_return_first<I>(iter: &mut I, total_step: usize) -> Option<I::Item>
390 /// let next = iter.next();
391 /// if total_step > 1 {
392 /// iter.nth(total_step-2);
400 /// The method will panic if the given step is `0`.
407 /// let a = [0, 1, 2, 3, 4, 5];
408 /// let mut iter = a.iter().step_by(2);
410 /// assert_eq!(iter.next(), Some(&0));
411 /// assert_eq!(iter.next(), Some(&2));
412 /// assert_eq!(iter.next(), Some(&4));
413 /// assert_eq!(iter.next(), None);
416 #[stable(feature = "iterator_step_by", since = "1.28.0")]
417 fn step_by(self, step: usize) -> StepBy<Self>
421 StepBy::new(self, step)
424 /// Takes two iterators and creates a new iterator over both in sequence.
426 /// `chain()` will return a new iterator which will first iterate over
427 /// values from the first iterator and then over values from the second
430 /// In other words, it links two iterators together, in a chain. 🔗
432 /// [`once`] is commonly used to adapt a single value into a chain of
433 /// other kinds of iteration.
440 /// let a1 = [1, 2, 3];
441 /// let a2 = [4, 5, 6];
443 /// let mut iter = a1.iter().chain(a2.iter());
445 /// assert_eq!(iter.next(), Some(&1));
446 /// assert_eq!(iter.next(), Some(&2));
447 /// assert_eq!(iter.next(), Some(&3));
448 /// assert_eq!(iter.next(), Some(&4));
449 /// assert_eq!(iter.next(), Some(&5));
450 /// assert_eq!(iter.next(), Some(&6));
451 /// assert_eq!(iter.next(), None);
454 /// Since the argument to `chain()` uses [`IntoIterator`], we can pass
455 /// anything that can be converted into an [`Iterator`], not just an
456 /// [`Iterator`] itself. For example, slices (`&[T]`) implement
457 /// [`IntoIterator`], and so can be passed to `chain()` directly:
460 /// let s1 = &[1, 2, 3];
461 /// let s2 = &[4, 5, 6];
463 /// let mut iter = s1.iter().chain(s2);
465 /// assert_eq!(iter.next(), Some(&1));
466 /// assert_eq!(iter.next(), Some(&2));
467 /// assert_eq!(iter.next(), Some(&3));
468 /// assert_eq!(iter.next(), Some(&4));
469 /// assert_eq!(iter.next(), Some(&5));
470 /// assert_eq!(iter.next(), Some(&6));
471 /// assert_eq!(iter.next(), None);
474 /// If you work with Windows API, you may wish to convert [`OsStr`] to `Vec<u16>`:
478 /// fn os_str_to_utf16(s: &std::ffi::OsStr) -> Vec<u16> {
479 /// use std::os::windows::ffi::OsStrExt;
480 /// s.encode_wide().chain(std::iter::once(0)).collect()
484 /// [`once`]: crate::iter::once
485 /// [`OsStr`]: ../../std/ffi/struct.OsStr.html
487 #[stable(feature = "rust1", since = "1.0.0")]
488 fn chain<U>(self, other: U) -> Chain<Self, U::IntoIter>
491 U: IntoIterator<Item = Self::Item>,
493 Chain::new(self, other.into_iter())
496 /// 'Zips up' two iterators into a single iterator of pairs.
498 /// `zip()` returns a new iterator that will iterate over two other
499 /// iterators, returning a tuple where the first element comes from the
500 /// first iterator, and the second element comes from the second iterator.
502 /// In other words, it zips two iterators together, into a single one.
504 /// If either iterator returns [`None`], [`next`] from the zipped iterator
505 /// will return [`None`]. If the first iterator returns [`None`], `zip` will
506 /// short-circuit and `next` will not be called on the second iterator.
513 /// let a1 = [1, 2, 3];
514 /// let a2 = [4, 5, 6];
516 /// let mut iter = a1.iter().zip(a2.iter());
518 /// assert_eq!(iter.next(), Some((&1, &4)));
519 /// assert_eq!(iter.next(), Some((&2, &5)));
520 /// assert_eq!(iter.next(), Some((&3, &6)));
521 /// assert_eq!(iter.next(), None);
524 /// Since the argument to `zip()` uses [`IntoIterator`], we can pass
525 /// anything that can be converted into an [`Iterator`], not just an
526 /// [`Iterator`] itself. For example, slices (`&[T]`) implement
527 /// [`IntoIterator`], and so can be passed to `zip()` directly:
530 /// let s1 = &[1, 2, 3];
531 /// let s2 = &[4, 5, 6];
533 /// let mut iter = s1.iter().zip(s2);
535 /// assert_eq!(iter.next(), Some((&1, &4)));
536 /// assert_eq!(iter.next(), Some((&2, &5)));
537 /// assert_eq!(iter.next(), Some((&3, &6)));
538 /// assert_eq!(iter.next(), None);
541 /// `zip()` is often used to zip an infinite iterator to a finite one.
542 /// This works because the finite iterator will eventually return [`None`],
543 /// ending the zipper. Zipping with `(0..)` can look a lot like [`enumerate`]:
546 /// let enumerate: Vec<_> = "foo".chars().enumerate().collect();
548 /// let zipper: Vec<_> = (0..).zip("foo".chars()).collect();
550 /// assert_eq!((0, 'f'), enumerate[0]);
551 /// assert_eq!((0, 'f'), zipper[0]);
553 /// assert_eq!((1, 'o'), enumerate[1]);
554 /// assert_eq!((1, 'o'), zipper[1]);
556 /// assert_eq!((2, 'o'), enumerate[2]);
557 /// assert_eq!((2, 'o'), zipper[2]);
560 /// [`enumerate`]: Iterator::enumerate
561 /// [`next`]: Iterator::next
563 #[stable(feature = "rust1", since = "1.0.0")]
564 fn zip<U>(self, other: U) -> Zip<Self, U::IntoIter>
569 Zip::new(self, other.into_iter())
572 /// Places a copy of `separator` between all elements.
579 /// #![feature(iter_intersperse)]
581 /// let hello = ["Hello", "World"].iter().copied().intersperse(" ").collect::<String>();
582 /// assert_eq!(hello, "Hello World");
585 #[unstable(feature = "iter_intersperse", reason = "recently added", issue = "79524")]
586 fn intersperse(self, separator: Self::Item) -> Intersperse<Self>
591 Intersperse::new(self, separator)
594 /// Takes a closure and creates an iterator which calls that closure on each
597 /// `map()` transforms one iterator into another, by means of its argument:
598 /// something that implements [`FnMut`]. It produces a new iterator which
599 /// calls this closure on each element of the original iterator.
601 /// If you are good at thinking in types, you can think of `map()` like this:
602 /// If you have an iterator that gives you elements of some type `A`, and
603 /// you want an iterator of some other type `B`, you can use `map()`,
604 /// passing a closure that takes an `A` and returns a `B`.
606 /// `map()` is conceptually similar to a [`for`] loop. However, as `map()` is
607 /// lazy, it is best used when you're already working with other iterators.
608 /// If you're doing some sort of looping for a side effect, it's considered
609 /// more idiomatic to use [`for`] than `map()`.
611 /// [`for`]: ../../book/ch03-05-control-flow.html#looping-through-a-collection-with-for
612 /// [`FnMut`]: crate::ops::FnMut
619 /// let a = [1, 2, 3];
621 /// let mut iter = a.iter().map(|x| 2 * x);
623 /// assert_eq!(iter.next(), Some(2));
624 /// assert_eq!(iter.next(), Some(4));
625 /// assert_eq!(iter.next(), Some(6));
626 /// assert_eq!(iter.next(), None);
629 /// If you're doing some sort of side effect, prefer [`for`] to `map()`:
632 /// # #![allow(unused_must_use)]
633 /// // don't do this:
634 /// (0..5).map(|x| println!("{}", x));
636 /// // it won't even execute, as it is lazy. Rust will warn you about this.
638 /// // Instead, use for:
640 /// println!("{}", x);
644 #[stable(feature = "rust1", since = "1.0.0")]
645 fn map<B, F>(self, f: F) -> Map<Self, F>
648 F: FnMut(Self::Item) -> B,
653 /// Calls a closure on each element of an iterator.
655 /// This is equivalent to using a [`for`] loop on the iterator, although
656 /// `break` and `continue` are not possible from a closure. It's generally
657 /// more idiomatic to use a `for` loop, but `for_each` may be more legible
658 /// when processing items at the end of longer iterator chains. In some
659 /// cases `for_each` may also be faster than a loop, because it will use
660 /// internal iteration on adaptors like `Chain`.
662 /// [`for`]: ../../book/ch03-05-control-flow.html#looping-through-a-collection-with-for
669 /// use std::sync::mpsc::channel;
671 /// let (tx, rx) = channel();
672 /// (0..5).map(|x| x * 2 + 1)
673 /// .for_each(move |x| tx.send(x).unwrap());
675 /// let v: Vec<_> = rx.iter().collect();
676 /// assert_eq!(v, vec![1, 3, 5, 7, 9]);
679 /// For such a small example, a `for` loop may be cleaner, but `for_each`
680 /// might be preferable to keep a functional style with longer iterators:
683 /// (0..5).flat_map(|x| x * 100 .. x * 110)
685 /// .filter(|&(i, x)| (i + x) % 3 == 0)
686 /// .for_each(|(i, x)| println!("{}:{}", i, x));
689 #[stable(feature = "iterator_for_each", since = "1.21.0")]
690 fn for_each<F>(self, f: F)
693 F: FnMut(Self::Item),
696 fn call<T>(mut f: impl FnMut(T)) -> impl FnMut((), T) {
697 move |(), item| f(item)
700 self.fold((), call(f));
703 /// Creates an iterator which uses a closure to determine if an element
704 /// should be yielded.
706 /// Given an element the closure must return `true` or `false`. The returned
707 /// iterator will yield only the elements for which the closure returns
715 /// let a = [0i32, 1, 2];
717 /// let mut iter = a.iter().filter(|x| x.is_positive());
719 /// assert_eq!(iter.next(), Some(&1));
720 /// assert_eq!(iter.next(), Some(&2));
721 /// assert_eq!(iter.next(), None);
724 /// Because the closure passed to `filter()` takes a reference, and many
725 /// iterators iterate over references, this leads to a possibly confusing
726 /// situation, where the type of the closure is a double reference:
729 /// let a = [0, 1, 2];
731 /// let mut iter = a.iter().filter(|x| **x > 1); // need two *s!
733 /// assert_eq!(iter.next(), Some(&2));
734 /// assert_eq!(iter.next(), None);
737 /// It's common to instead use destructuring on the argument to strip away
741 /// let a = [0, 1, 2];
743 /// let mut iter = a.iter().filter(|&x| *x > 1); // both & and *
745 /// assert_eq!(iter.next(), Some(&2));
746 /// assert_eq!(iter.next(), None);
752 /// let a = [0, 1, 2];
754 /// let mut iter = a.iter().filter(|&&x| x > 1); // two &s
756 /// assert_eq!(iter.next(), Some(&2));
757 /// assert_eq!(iter.next(), None);
762 /// Note that `iter.filter(f).next()` is equivalent to `iter.find(f)`.
764 #[stable(feature = "rust1", since = "1.0.0")]
765 fn filter<P>(self, predicate: P) -> Filter<Self, P>
768 P: FnMut(&Self::Item) -> bool,
770 Filter::new(self, predicate)
773 /// Creates an iterator that both filters and maps.
775 /// The returned iterator yields only the `value`s for which the supplied
776 /// closure returns `Some(value)`.
778 /// `filter_map` can be used to make chains of [`filter`] and [`map`] more
779 /// concise. The example below shows how a `map().filter().map()` can be
780 /// shortened to a single call to `filter_map`.
782 /// [`filter`]: Iterator::filter
783 /// [`map`]: Iterator::map
790 /// let a = ["1", "two", "NaN", "four", "5"];
792 /// let mut iter = a.iter().filter_map(|s| s.parse().ok());
794 /// assert_eq!(iter.next(), Some(1));
795 /// assert_eq!(iter.next(), Some(5));
796 /// assert_eq!(iter.next(), None);
799 /// Here's the same example, but with [`filter`] and [`map`]:
802 /// let a = ["1", "two", "NaN", "four", "5"];
803 /// let mut iter = a.iter().map(|s| s.parse()).filter(|s| s.is_ok()).map(|s| s.unwrap());
804 /// assert_eq!(iter.next(), Some(1));
805 /// assert_eq!(iter.next(), Some(5));
806 /// assert_eq!(iter.next(), None);
809 /// [`Option<T>`]: Option
811 #[stable(feature = "rust1", since = "1.0.0")]
812 fn filter_map<B, F>(self, f: F) -> FilterMap<Self, F>
815 F: FnMut(Self::Item) -> Option<B>,
817 FilterMap::new(self, f)
820 /// Creates an iterator which gives the current iteration count as well as
823 /// The iterator returned yields pairs `(i, val)`, where `i` is the
824 /// current index of iteration and `val` is the value returned by the
827 /// `enumerate()` keeps its count as a [`usize`]. If you want to count by a
828 /// different sized integer, the [`zip`] function provides similar
831 /// # Overflow Behavior
833 /// The method does no guarding against overflows, so enumerating more than
834 /// [`usize::MAX`] elements either produces the wrong result or panics. If
835 /// debug assertions are enabled, a panic is guaranteed.
839 /// The returned iterator might panic if the to-be-returned index would
840 /// overflow a [`usize`].
842 /// [`usize`]: type@usize
843 /// [`usize::MAX`]: crate::usize::MAX
844 /// [`zip`]: Iterator::zip
849 /// let a = ['a', 'b', 'c'];
851 /// let mut iter = a.iter().enumerate();
853 /// assert_eq!(iter.next(), Some((0, &'a')));
854 /// assert_eq!(iter.next(), Some((1, &'b')));
855 /// assert_eq!(iter.next(), Some((2, &'c')));
856 /// assert_eq!(iter.next(), None);
859 #[stable(feature = "rust1", since = "1.0.0")]
860 fn enumerate(self) -> Enumerate<Self>
867 /// Creates an iterator which can use [`peek`] to look at the next element of
868 /// the iterator without consuming it.
870 /// Adds a [`peek`] method to an iterator. See its documentation for
871 /// more information.
873 /// Note that the underlying iterator is still advanced when [`peek`] is
874 /// called for the first time: In order to retrieve the next element,
875 /// [`next`] is called on the underlying iterator, hence any side effects (i.e.
876 /// anything other than fetching the next value) of the [`next`] method
879 /// [`peek`]: Peekable::peek
880 /// [`next`]: Iterator::next
887 /// let xs = [1, 2, 3];
889 /// let mut iter = xs.iter().peekable();
891 /// // peek() lets us see into the future
892 /// assert_eq!(iter.peek(), Some(&&1));
893 /// assert_eq!(iter.next(), Some(&1));
895 /// assert_eq!(iter.next(), Some(&2));
897 /// // we can peek() multiple times, the iterator won't advance
898 /// assert_eq!(iter.peek(), Some(&&3));
899 /// assert_eq!(iter.peek(), Some(&&3));
901 /// assert_eq!(iter.next(), Some(&3));
903 /// // after the iterator is finished, so is peek()
904 /// assert_eq!(iter.peek(), None);
905 /// assert_eq!(iter.next(), None);
908 #[stable(feature = "rust1", since = "1.0.0")]
909 fn peekable(self) -> Peekable<Self>
916 /// Creates an iterator that [`skip`]s elements based on a predicate.
918 /// [`skip`]: Iterator::skip
920 /// `skip_while()` takes a closure as an argument. It will call this
921 /// closure on each element of the iterator, and ignore elements
922 /// until it returns `false`.
924 /// After `false` is returned, `skip_while()`'s job is over, and the
925 /// rest of the elements are yielded.
932 /// let a = [-1i32, 0, 1];
934 /// let mut iter = a.iter().skip_while(|x| x.is_negative());
936 /// assert_eq!(iter.next(), Some(&0));
937 /// assert_eq!(iter.next(), Some(&1));
938 /// assert_eq!(iter.next(), None);
941 /// Because the closure passed to `skip_while()` takes a reference, and many
942 /// iterators iterate over references, this leads to a possibly confusing
943 /// situation, where the type of the closure is a double reference:
946 /// let a = [-1, 0, 1];
948 /// let mut iter = a.iter().skip_while(|x| **x < 0); // need two *s!
950 /// assert_eq!(iter.next(), Some(&0));
951 /// assert_eq!(iter.next(), Some(&1));
952 /// assert_eq!(iter.next(), None);
955 /// Stopping after an initial `false`:
958 /// let a = [-1, 0, 1, -2];
960 /// let mut iter = a.iter().skip_while(|x| **x < 0);
962 /// assert_eq!(iter.next(), Some(&0));
963 /// assert_eq!(iter.next(), Some(&1));
965 /// // while this would have been false, since we already got a false,
966 /// // skip_while() isn't used any more
967 /// assert_eq!(iter.next(), Some(&-2));
969 /// assert_eq!(iter.next(), None);
972 #[stable(feature = "rust1", since = "1.0.0")]
973 fn skip_while<P>(self, predicate: P) -> SkipWhile<Self, P>
976 P: FnMut(&Self::Item) -> bool,
978 SkipWhile::new(self, predicate)
981 /// Creates an iterator that yields elements based on a predicate.
983 /// `take_while()` takes a closure as an argument. It will call this
984 /// closure on each element of the iterator, and yield elements
985 /// while it returns `true`.
987 /// After `false` is returned, `take_while()`'s job is over, and the
988 /// rest of the elements are ignored.
995 /// let a = [-1i32, 0, 1];
997 /// let mut iter = a.iter().take_while(|x| x.is_negative());
999 /// assert_eq!(iter.next(), Some(&-1));
1000 /// assert_eq!(iter.next(), None);
1003 /// Because the closure passed to `take_while()` takes a reference, and many
1004 /// iterators iterate over references, this leads to a possibly confusing
1005 /// situation, where the type of the closure is a double reference:
1008 /// let a = [-1, 0, 1];
1010 /// let mut iter = a.iter().take_while(|x| **x < 0); // need two *s!
1012 /// assert_eq!(iter.next(), Some(&-1));
1013 /// assert_eq!(iter.next(), None);
1016 /// Stopping after an initial `false`:
1019 /// let a = [-1, 0, 1, -2];
1021 /// let mut iter = a.iter().take_while(|x| **x < 0);
1023 /// assert_eq!(iter.next(), Some(&-1));
1025 /// // We have more elements that are less than zero, but since we already
1026 /// // got a false, take_while() isn't used any more
1027 /// assert_eq!(iter.next(), None);
1030 /// Because `take_while()` needs to look at the value in order to see if it
1031 /// should be included or not, consuming iterators will see that it is
1035 /// let a = [1, 2, 3, 4];
1036 /// let mut iter = a.iter();
1038 /// let result: Vec<i32> = iter.by_ref()
1039 /// .take_while(|n| **n != 3)
1043 /// assert_eq!(result, &[1, 2]);
1045 /// let result: Vec<i32> = iter.cloned().collect();
1047 /// assert_eq!(result, &[4]);
1050 /// The `3` is no longer there, because it was consumed in order to see if
1051 /// the iteration should stop, but wasn't placed back into the iterator.
1053 #[stable(feature = "rust1", since = "1.0.0")]
1054 fn take_while<P>(self, predicate: P) -> TakeWhile<Self, P>
1057 P: FnMut(&Self::Item) -> bool,
1059 TakeWhile::new(self, predicate)
1062 /// Creates an iterator that both yields elements based on a predicate and maps.
1064 /// `map_while()` takes a closure as an argument. It will call this
1065 /// closure on each element of the iterator, and yield elements
1066 /// while it returns [`Some(_)`][`Some`].
1073 /// #![feature(iter_map_while)]
1074 /// let a = [-1i32, 4, 0, 1];
1076 /// let mut iter = a.iter().map_while(|x| 16i32.checked_div(*x));
1078 /// assert_eq!(iter.next(), Some(-16));
1079 /// assert_eq!(iter.next(), Some(4));
1080 /// assert_eq!(iter.next(), None);
1083 /// Here's the same example, but with [`take_while`] and [`map`]:
1085 /// [`take_while`]: Iterator::take_while
1086 /// [`map`]: Iterator::map
1089 /// let a = [-1i32, 4, 0, 1];
1091 /// let mut iter = a.iter()
1092 /// .map(|x| 16i32.checked_div(*x))
1093 /// .take_while(|x| x.is_some())
1094 /// .map(|x| x.unwrap());
1096 /// assert_eq!(iter.next(), Some(-16));
1097 /// assert_eq!(iter.next(), Some(4));
1098 /// assert_eq!(iter.next(), None);
1101 /// Stopping after an initial [`None`]:
1104 /// #![feature(iter_map_while)]
1105 /// use std::convert::TryFrom;
1107 /// let a = [0, 1, 2, -3, 4, 5, -6];
1109 /// let iter = a.iter().map_while(|x| u32::try_from(*x).ok());
1110 /// let vec = iter.collect::<Vec<_>>();
1112 /// // We have more elements which could fit in u32 (4, 5), but `map_while` returned `None` for `-3`
1113 /// // (as the `predicate` returned `None`) and `collect` stops at the first `None` encountered.
1114 /// assert_eq!(vec, vec![0, 1, 2]);
1117 /// Because `map_while()` needs to look at the value in order to see if it
1118 /// should be included or not, consuming iterators will see that it is
1122 /// #![feature(iter_map_while)]
1123 /// use std::convert::TryFrom;
1125 /// let a = [1, 2, -3, 4];
1126 /// let mut iter = a.iter();
1128 /// let result: Vec<u32> = iter.by_ref()
1129 /// .map_while(|n| u32::try_from(*n).ok())
1132 /// assert_eq!(result, &[1, 2]);
1134 /// let result: Vec<i32> = iter.cloned().collect();
1136 /// assert_eq!(result, &[4]);
1139 /// The `-3` is no longer there, because it was consumed in order to see if
1140 /// the iteration should stop, but wasn't placed back into the iterator.
1142 /// Note that unlike [`take_while`] this iterator is **not** fused.
1143 /// It is also not specified what this iterator returns after the first` None` is returned.
1144 /// If you need fused iterator, use [`fuse`].
1146 /// [`fuse`]: Iterator::fuse
1148 #[unstable(feature = "iter_map_while", reason = "recently added", issue = "68537")]
1149 fn map_while<B, P>(self, predicate: P) -> MapWhile<Self, P>
1152 P: FnMut(Self::Item) -> Option<B>,
1154 MapWhile::new(self, predicate)
1157 /// Creates an iterator that skips the first `n` elements.
1159 /// After they have been consumed, the rest of the elements are yielded.
1160 /// Rather than overriding this method directly, instead override the `nth` method.
1167 /// let a = [1, 2, 3];
1169 /// let mut iter = a.iter().skip(2);
1171 /// assert_eq!(iter.next(), Some(&3));
1172 /// assert_eq!(iter.next(), None);
1175 #[stable(feature = "rust1", since = "1.0.0")]
1176 fn skip(self, n: usize) -> Skip<Self>
1183 /// Creates an iterator that yields its first `n` elements.
1190 /// let a = [1, 2, 3];
1192 /// let mut iter = a.iter().take(2);
1194 /// assert_eq!(iter.next(), Some(&1));
1195 /// assert_eq!(iter.next(), Some(&2));
1196 /// assert_eq!(iter.next(), None);
1199 /// `take()` is often used with an infinite iterator, to make it finite:
1202 /// let mut iter = (0..).take(3);
1204 /// assert_eq!(iter.next(), Some(0));
1205 /// assert_eq!(iter.next(), Some(1));
1206 /// assert_eq!(iter.next(), Some(2));
1207 /// assert_eq!(iter.next(), None);
1210 /// If less than `n` elements are available,
1211 /// `take` will limit itself to the size of the underlying iterator:
1214 /// let v = vec![1, 2];
1215 /// let mut iter = v.into_iter().take(5);
1216 /// assert_eq!(iter.next(), Some(1));
1217 /// assert_eq!(iter.next(), Some(2));
1218 /// assert_eq!(iter.next(), None);
1221 #[stable(feature = "rust1", since = "1.0.0")]
1222 fn take(self, n: usize) -> Take<Self>
1229 /// An iterator adaptor similar to [`fold`] that holds internal state and
1230 /// produces a new iterator.
1232 /// [`fold`]: Iterator::fold
1234 /// `scan()` takes two arguments: an initial value which seeds the internal
1235 /// state, and a closure with two arguments, the first being a mutable
1236 /// reference to the internal state and the second an iterator element.
1237 /// The closure can assign to the internal state to share state between
1240 /// On iteration, the closure will be applied to each element of the
1241 /// iterator and the return value from the closure, an [`Option`], is
1242 /// yielded by the iterator.
1249 /// let a = [1, 2, 3];
1251 /// let mut iter = a.iter().scan(1, |state, &x| {
1252 /// // each iteration, we'll multiply the state by the element
1253 /// *state = *state * x;
1255 /// // then, we'll yield the negation of the state
1259 /// assert_eq!(iter.next(), Some(-1));
1260 /// assert_eq!(iter.next(), Some(-2));
1261 /// assert_eq!(iter.next(), Some(-6));
1262 /// assert_eq!(iter.next(), None);
1265 #[stable(feature = "rust1", since = "1.0.0")]
1266 fn scan<St, B, F>(self, initial_state: St, f: F) -> Scan<Self, St, F>
1269 F: FnMut(&mut St, Self::Item) -> Option<B>,
1271 Scan::new(self, initial_state, f)
1274 /// Creates an iterator that works like map, but flattens nested structure.
1276 /// The [`map`] adapter is very useful, but only when the closure
1277 /// argument produces values. If it produces an iterator instead, there's
1278 /// an extra layer of indirection. `flat_map()` will remove this extra layer
1281 /// You can think of `flat_map(f)` as the semantic equivalent
1282 /// of [`map`]ping, and then [`flatten`]ing as in `map(f).flatten()`.
1284 /// Another way of thinking about `flat_map()`: [`map`]'s closure returns
1285 /// one item for each element, and `flat_map()`'s closure returns an
1286 /// iterator for each element.
1288 /// [`map`]: Iterator::map
1289 /// [`flatten`]: Iterator::flatten
1296 /// let words = ["alpha", "beta", "gamma"];
1298 /// // chars() returns an iterator
1299 /// let merged: String = words.iter()
1300 /// .flat_map(|s| s.chars())
1302 /// assert_eq!(merged, "alphabetagamma");
1305 #[stable(feature = "rust1", since = "1.0.0")]
1306 fn flat_map<U, F>(self, f: F) -> FlatMap<Self, U, F>
1310 F: FnMut(Self::Item) -> U,
1312 FlatMap::new(self, f)
1315 /// Creates an iterator that flattens nested structure.
1317 /// This is useful when you have an iterator of iterators or an iterator of
1318 /// things that can be turned into iterators and you want to remove one
1319 /// level of indirection.
1326 /// let data = vec![vec![1, 2, 3, 4], vec![5, 6]];
1327 /// let flattened = data.into_iter().flatten().collect::<Vec<u8>>();
1328 /// assert_eq!(flattened, &[1, 2, 3, 4, 5, 6]);
1331 /// Mapping and then flattening:
1334 /// let words = ["alpha", "beta", "gamma"];
1336 /// // chars() returns an iterator
1337 /// let merged: String = words.iter()
1338 /// .map(|s| s.chars())
1341 /// assert_eq!(merged, "alphabetagamma");
1344 /// You can also rewrite this in terms of [`flat_map()`], which is preferable
1345 /// in this case since it conveys intent more clearly:
1348 /// let words = ["alpha", "beta", "gamma"];
1350 /// // chars() returns an iterator
1351 /// let merged: String = words.iter()
1352 /// .flat_map(|s| s.chars())
1354 /// assert_eq!(merged, "alphabetagamma");
1357 /// Flattening only removes one level of nesting at a time:
1360 /// let d3 = [[[1, 2], [3, 4]], [[5, 6], [7, 8]]];
1362 /// let d2 = d3.iter().flatten().collect::<Vec<_>>();
1363 /// assert_eq!(d2, [&[1, 2], &[3, 4], &[5, 6], &[7, 8]]);
1365 /// let d1 = d3.iter().flatten().flatten().collect::<Vec<_>>();
1366 /// assert_eq!(d1, [&1, &2, &3, &4, &5, &6, &7, &8]);
1369 /// Here we see that `flatten()` does not perform a "deep" flatten.
1370 /// Instead, only one level of nesting is removed. That is, if you
1371 /// `flatten()` a three-dimensional array, the result will be
1372 /// two-dimensional and not one-dimensional. To get a one-dimensional
1373 /// structure, you have to `flatten()` again.
1375 /// [`flat_map()`]: Iterator::flat_map
1377 #[stable(feature = "iterator_flatten", since = "1.29.0")]
1378 fn flatten(self) -> Flatten<Self>
1381 Self::Item: IntoIterator,
1386 /// Creates an iterator which ends after the first [`None`].
1388 /// After an iterator returns [`None`], future calls may or may not yield
1389 /// [`Some(T)`] again. `fuse()` adapts an iterator, ensuring that after a
1390 /// [`None`] is given, it will always return [`None`] forever.
1392 /// [`Some(T)`]: Some
1399 /// // an iterator which alternates between Some and None
1400 /// struct Alternate {
1404 /// impl Iterator for Alternate {
1405 /// type Item = i32;
1407 /// fn next(&mut self) -> Option<i32> {
1408 /// let val = self.state;
1409 /// self.state = self.state + 1;
1411 /// // if it's even, Some(i32), else None
1412 /// if val % 2 == 0 {
1420 /// let mut iter = Alternate { state: 0 };
1422 /// // we can see our iterator going back and forth
1423 /// assert_eq!(iter.next(), Some(0));
1424 /// assert_eq!(iter.next(), None);
1425 /// assert_eq!(iter.next(), Some(2));
1426 /// assert_eq!(iter.next(), None);
1428 /// // however, once we fuse it...
1429 /// let mut iter = iter.fuse();
1431 /// assert_eq!(iter.next(), Some(4));
1432 /// assert_eq!(iter.next(), None);
1434 /// // it will always return `None` after the first time.
1435 /// assert_eq!(iter.next(), None);
1436 /// assert_eq!(iter.next(), None);
1437 /// assert_eq!(iter.next(), None);
1440 #[stable(feature = "rust1", since = "1.0.0")]
1441 fn fuse(self) -> Fuse<Self>
1448 /// Does something with each element of an iterator, passing the value on.
1450 /// When using iterators, you'll often chain several of them together.
1451 /// While working on such code, you might want to check out what's
1452 /// happening at various parts in the pipeline. To do that, insert
1453 /// a call to `inspect()`.
1455 /// It's more common for `inspect()` to be used as a debugging tool than to
1456 /// exist in your final code, but applications may find it useful in certain
1457 /// situations when errors need to be logged before being discarded.
1464 /// let a = [1, 4, 2, 3];
1466 /// // this iterator sequence is complex.
1467 /// let sum = a.iter()
1469 /// .filter(|x| x % 2 == 0)
1470 /// .fold(0, |sum, i| sum + i);
1472 /// println!("{}", sum);
1474 /// // let's add some inspect() calls to investigate what's happening
1475 /// let sum = a.iter()
1477 /// .inspect(|x| println!("about to filter: {}", x))
1478 /// .filter(|x| x % 2 == 0)
1479 /// .inspect(|x| println!("made it through filter: {}", x))
1480 /// .fold(0, |sum, i| sum + i);
1482 /// println!("{}", sum);
1485 /// This will print:
1489 /// about to filter: 1
1490 /// about to filter: 4
1491 /// made it through filter: 4
1492 /// about to filter: 2
1493 /// made it through filter: 2
1494 /// about to filter: 3
1498 /// Logging errors before discarding them:
1501 /// let lines = ["1", "2", "a"];
1503 /// let sum: i32 = lines
1505 /// .map(|line| line.parse::<i32>())
1506 /// .inspect(|num| {
1507 /// if let Err(ref e) = *num {
1508 /// println!("Parsing error: {}", e);
1511 /// .filter_map(Result::ok)
1514 /// println!("Sum: {}", sum);
1517 /// This will print:
1520 /// Parsing error: invalid digit found in string
1524 #[stable(feature = "rust1", since = "1.0.0")]
1525 fn inspect<F>(self, f: F) -> Inspect<Self, F>
1528 F: FnMut(&Self::Item),
1530 Inspect::new(self, f)
1533 /// Borrows an iterator, rather than consuming it.
1535 /// This is useful to allow applying iterator adaptors while still
1536 /// retaining ownership of the original iterator.
1543 /// let a = [1, 2, 3];
1545 /// let iter = a.iter();
1547 /// let sum: i32 = iter.take(5).fold(0, |acc, i| acc + i);
1549 /// assert_eq!(sum, 6);
1551 /// // if we try to use iter again, it won't work. The following line
1552 /// // gives "error: use of moved value: `iter`
1553 /// // assert_eq!(iter.next(), None);
1555 /// // let's try that again
1556 /// let a = [1, 2, 3];
1558 /// let mut iter = a.iter();
1560 /// // instead, we add in a .by_ref()
1561 /// let sum: i32 = iter.by_ref().take(2).fold(0, |acc, i| acc + i);
1563 /// assert_eq!(sum, 3);
1565 /// // now this is just fine:
1566 /// assert_eq!(iter.next(), Some(&3));
1567 /// assert_eq!(iter.next(), None);
1569 #[stable(feature = "rust1", since = "1.0.0")]
1570 fn by_ref(&mut self) -> &mut Self
1577 /// Transforms an iterator into a collection.
1579 /// `collect()` can take anything iterable, and turn it into a relevant
1580 /// collection. This is one of the more powerful methods in the standard
1581 /// library, used in a variety of contexts.
1583 /// The most basic pattern in which `collect()` is used is to turn one
1584 /// collection into another. You take a collection, call [`iter`] on it,
1585 /// do a bunch of transformations, and then `collect()` at the end.
1587 /// `collect()` can also create instances of types that are not typical
1588 /// collections. For example, a [`String`] can be built from [`char`]s,
1589 /// and an iterator of [`Result<T, E>`][`Result`] items can be collected
1590 /// into `Result<Collection<T>, E>`. See the examples below for more.
1592 /// Because `collect()` is so general, it can cause problems with type
1593 /// inference. As such, `collect()` is one of the few times you'll see
1594 /// the syntax affectionately known as the 'turbofish': `::<>`. This
1595 /// helps the inference algorithm understand specifically which collection
1596 /// you're trying to collect into.
1603 /// let a = [1, 2, 3];
1605 /// let doubled: Vec<i32> = a.iter()
1606 /// .map(|&x| x * 2)
1609 /// assert_eq!(vec![2, 4, 6], doubled);
1612 /// Note that we needed the `: Vec<i32>` on the left-hand side. This is because
1613 /// we could collect into, for example, a [`VecDeque<T>`] instead:
1615 /// [`VecDeque<T>`]: ../../std/collections/struct.VecDeque.html
1618 /// use std::collections::VecDeque;
1620 /// let a = [1, 2, 3];
1622 /// let doubled: VecDeque<i32> = a.iter().map(|&x| x * 2).collect();
1624 /// assert_eq!(2, doubled[0]);
1625 /// assert_eq!(4, doubled[1]);
1626 /// assert_eq!(6, doubled[2]);
1629 /// Using the 'turbofish' instead of annotating `doubled`:
1632 /// let a = [1, 2, 3];
1634 /// let doubled = a.iter().map(|x| x * 2).collect::<Vec<i32>>();
1636 /// assert_eq!(vec![2, 4, 6], doubled);
1639 /// Because `collect()` only cares about what you're collecting into, you can
1640 /// still use a partial type hint, `_`, with the turbofish:
1643 /// let a = [1, 2, 3];
1645 /// let doubled = a.iter().map(|x| x * 2).collect::<Vec<_>>();
1647 /// assert_eq!(vec![2, 4, 6], doubled);
1650 /// Using `collect()` to make a [`String`]:
1653 /// let chars = ['g', 'd', 'k', 'k', 'n'];
1655 /// let hello: String = chars.iter()
1656 /// .map(|&x| x as u8)
1657 /// .map(|x| (x + 1) as char)
1660 /// assert_eq!("hello", hello);
1663 /// If you have a list of [`Result<T, E>`][`Result`]s, you can use `collect()` to
1664 /// see if any of them failed:
1667 /// let results = [Ok(1), Err("nope"), Ok(3), Err("bad")];
1669 /// let result: Result<Vec<_>, &str> = results.iter().cloned().collect();
1671 /// // gives us the first error
1672 /// assert_eq!(Err("nope"), result);
1674 /// let results = [Ok(1), Ok(3)];
1676 /// let result: Result<Vec<_>, &str> = results.iter().cloned().collect();
1678 /// // gives us the list of answers
1679 /// assert_eq!(Ok(vec![1, 3]), result);
1682 /// [`iter`]: Iterator::next
1683 /// [`String`]: ../../std/string/struct.String.html
1684 /// [`char`]: type@char
1686 #[stable(feature = "rust1", since = "1.0.0")]
1687 #[must_use = "if you really need to exhaust the iterator, consider `.for_each(drop)` instead"]
1688 fn collect<B: FromIterator<Self::Item>>(self) -> B
1692 FromIterator::from_iter(self)
1695 /// Consumes an iterator, creating two collections from it.
1697 /// The predicate passed to `partition()` can return `true`, or `false`.
1698 /// `partition()` returns a pair, all of the elements for which it returned
1699 /// `true`, and all of the elements for which it returned `false`.
1701 /// See also [`is_partitioned()`] and [`partition_in_place()`].
1703 /// [`is_partitioned()`]: Iterator::is_partitioned
1704 /// [`partition_in_place()`]: Iterator::partition_in_place
1711 /// let a = [1, 2, 3];
1713 /// let (even, odd): (Vec<i32>, Vec<i32>) = a
1715 /// .partition(|&n| n % 2 == 0);
1717 /// assert_eq!(even, vec![2]);
1718 /// assert_eq!(odd, vec![1, 3]);
1720 #[stable(feature = "rust1", since = "1.0.0")]
1721 fn partition<B, F>(self, f: F) -> (B, B)
1724 B: Default + Extend<Self::Item>,
1725 F: FnMut(&Self::Item) -> bool,
1728 fn extend<'a, T, B: Extend<T>>(
1729 mut f: impl FnMut(&T) -> bool + 'a,
1732 ) -> impl FnMut((), T) + 'a {
1737 right.extend_one(x);
1742 let mut left: B = Default::default();
1743 let mut right: B = Default::default();
1745 self.fold((), extend(f, &mut left, &mut right));
1750 /// Reorders the elements of this iterator *in-place* according to the given predicate,
1751 /// such that all those that return `true` precede all those that return `false`.
1752 /// Returns the number of `true` elements found.
1754 /// The relative order of partitioned items is not maintained.
1756 /// See also [`is_partitioned()`] and [`partition()`].
1758 /// [`is_partitioned()`]: Iterator::is_partitioned
1759 /// [`partition()`]: Iterator::partition
1764 /// #![feature(iter_partition_in_place)]
1766 /// let mut a = [1, 2, 3, 4, 5, 6, 7];
1768 /// // Partition in-place between evens and odds
1769 /// let i = a.iter_mut().partition_in_place(|&n| n % 2 == 0);
1771 /// assert_eq!(i, 3);
1772 /// assert!(a[..i].iter().all(|&n| n % 2 == 0)); // evens
1773 /// assert!(a[i..].iter().all(|&n| n % 2 == 1)); // odds
1775 #[unstable(feature = "iter_partition_in_place", reason = "new API", issue = "62543")]
1776 fn partition_in_place<'a, T: 'a, P>(mut self, ref mut predicate: P) -> usize
1778 Self: Sized + DoubleEndedIterator<Item = &'a mut T>,
1779 P: FnMut(&T) -> bool,
1781 // FIXME: should we worry about the count overflowing? The only way to have more than
1782 // `usize::MAX` mutable references is with ZSTs, which aren't useful to partition...
1784 // These closure "factory" functions exist to avoid genericity in `Self`.
1788 predicate: &'a mut impl FnMut(&T) -> bool,
1789 true_count: &'a mut usize,
1790 ) -> impl FnMut(&&mut T) -> bool + 'a {
1792 let p = predicate(&**x);
1793 *true_count += p as usize;
1799 fn is_true<T>(predicate: &mut impl FnMut(&T) -> bool) -> impl FnMut(&&mut T) -> bool + '_ {
1800 move |x| predicate(&**x)
1803 // Repeatedly find the first `false` and swap it with the last `true`.
1804 let mut true_count = 0;
1805 while let Some(head) = self.find(is_false(predicate, &mut true_count)) {
1806 if let Some(tail) = self.rfind(is_true(predicate)) {
1807 crate::mem::swap(head, tail);
1816 /// Checks if the elements of this iterator are partitioned according to the given predicate,
1817 /// such that all those that return `true` precede all those that return `false`.
1819 /// See also [`partition()`] and [`partition_in_place()`].
1821 /// [`partition()`]: Iterator::partition
1822 /// [`partition_in_place()`]: Iterator::partition_in_place
1827 /// #![feature(iter_is_partitioned)]
1829 /// assert!("Iterator".chars().is_partitioned(char::is_uppercase));
1830 /// assert!(!"IntoIterator".chars().is_partitioned(char::is_uppercase));
1832 #[unstable(feature = "iter_is_partitioned", reason = "new API", issue = "62544")]
1833 fn is_partitioned<P>(mut self, mut predicate: P) -> bool
1836 P: FnMut(Self::Item) -> bool,
1838 // Either all items test `true`, or the first clause stops at `false`
1839 // and we check that there are no more `true` items after that.
1840 self.all(&mut predicate) || !self.any(predicate)
1843 /// An iterator method that applies a function as long as it returns
1844 /// successfully, producing a single, final value.
1846 /// `try_fold()` takes two arguments: an initial value, and a closure with
1847 /// two arguments: an 'accumulator', and an element. The closure either
1848 /// returns successfully, with the value that the accumulator should have
1849 /// for the next iteration, or it returns failure, with an error value that
1850 /// is propagated back to the caller immediately (short-circuiting).
1852 /// The initial value is the value the accumulator will have on the first
1853 /// call. If applying the closure succeeded against every element of the
1854 /// iterator, `try_fold()` returns the final accumulator as success.
1856 /// Folding is useful whenever you have a collection of something, and want
1857 /// to produce a single value from it.
1859 /// # Note to Implementors
1861 /// Several of the other (forward) methods have default implementations in
1862 /// terms of this one, so try to implement this explicitly if it can
1863 /// do something better than the default `for` loop implementation.
1865 /// In particular, try to have this call `try_fold()` on the internal parts
1866 /// from which this iterator is composed. If multiple calls are needed,
1867 /// the `?` operator may be convenient for chaining the accumulator value
1868 /// along, but beware any invariants that need to be upheld before those
1869 /// early returns. This is a `&mut self` method, so iteration needs to be
1870 /// resumable after hitting an error here.
1877 /// let a = [1, 2, 3];
1879 /// // the checked sum of all of the elements of the array
1880 /// let sum = a.iter().try_fold(0i8, |acc, &x| acc.checked_add(x));
1882 /// assert_eq!(sum, Some(6));
1885 /// Short-circuiting:
1888 /// let a = [10, 20, 30, 100, 40, 50];
1889 /// let mut it = a.iter();
1891 /// // This sum overflows when adding the 100 element
1892 /// let sum = it.try_fold(0i8, |acc, &x| acc.checked_add(x));
1893 /// assert_eq!(sum, None);
1895 /// // Because it short-circuited, the remaining elements are still
1896 /// // available through the iterator.
1897 /// assert_eq!(it.len(), 2);
1898 /// assert_eq!(it.next(), Some(&40));
1901 #[stable(feature = "iterator_try_fold", since = "1.27.0")]
1902 fn try_fold<B, F, R>(&mut self, init: B, mut f: F) -> R
1905 F: FnMut(B, Self::Item) -> R,
1908 let mut accum = init;
1909 while let Some(x) = self.next() {
1910 accum = f(accum, x)?;
1915 /// An iterator method that applies a fallible function to each item in the
1916 /// iterator, stopping at the first error and returning that error.
1918 /// This can also be thought of as the fallible form of [`for_each()`]
1919 /// or as the stateless version of [`try_fold()`].
1921 /// [`for_each()`]: Iterator::for_each
1922 /// [`try_fold()`]: Iterator::try_fold
1927 /// use std::fs::rename;
1928 /// use std::io::{stdout, Write};
1929 /// use std::path::Path;
1931 /// let data = ["no_tea.txt", "stale_bread.json", "torrential_rain.png"];
1933 /// let res = data.iter().try_for_each(|x| writeln!(stdout(), "{}", x));
1934 /// assert!(res.is_ok());
1936 /// let mut it = data.iter().cloned();
1937 /// let res = it.try_for_each(|x| rename(x, Path::new(x).with_extension("old")));
1938 /// assert!(res.is_err());
1939 /// // It short-circuited, so the remaining items are still in the iterator:
1940 /// assert_eq!(it.next(), Some("stale_bread.json"));
1943 #[stable(feature = "iterator_try_fold", since = "1.27.0")]
1944 fn try_for_each<F, R>(&mut self, f: F) -> R
1947 F: FnMut(Self::Item) -> R,
1951 fn call<T, R>(mut f: impl FnMut(T) -> R) -> impl FnMut((), T) -> R {
1955 self.try_fold((), call(f))
1958 /// An iterator method that applies a function, producing a single, final value.
1960 /// `fold()` takes two arguments: an initial value, and a closure with two
1961 /// arguments: an 'accumulator', and an element. The closure returns the value that
1962 /// the accumulator should have for the next iteration.
1964 /// The initial value is the value the accumulator will have on the first
1967 /// After applying this closure to every element of the iterator, `fold()`
1968 /// returns the accumulator.
1970 /// This operation is sometimes called 'reduce' or 'inject'.
1972 /// Folding is useful whenever you have a collection of something, and want
1973 /// to produce a single value from it.
1975 /// Note: `fold()`, and similar methods that traverse the entire iterator,
1976 /// may not terminate for infinite iterators, even on traits for which a
1977 /// result is determinable in finite time.
1979 /// # Note to Implementors
1981 /// Several of the other (forward) methods have default implementations in
1982 /// terms of this one, so try to implement this explicitly if it can
1983 /// do something better than the default `for` loop implementation.
1985 /// In particular, try to have this call `fold()` on the internal parts
1986 /// from which this iterator is composed.
1993 /// let a = [1, 2, 3];
1995 /// // the sum of all of the elements of the array
1996 /// let sum = a.iter().fold(0, |acc, x| acc + x);
1998 /// assert_eq!(sum, 6);
2001 /// Let's walk through each step of the iteration here:
2003 /// | element | acc | x | result |
2004 /// |---------|-----|---|--------|
2006 /// | 1 | 0 | 1 | 1 |
2007 /// | 2 | 1 | 2 | 3 |
2008 /// | 3 | 3 | 3 | 6 |
2010 /// And so, our final result, `6`.
2012 /// It's common for people who haven't used iterators a lot to
2013 /// use a `for` loop with a list of things to build up a result. Those
2014 /// can be turned into `fold()`s:
2016 /// [`for`]: ../../book/ch03-05-control-flow.html#looping-through-a-collection-with-for
2019 /// let numbers = [1, 2, 3, 4, 5];
2021 /// let mut result = 0;
2024 /// for i in &numbers {
2025 /// result = result + i;
2029 /// let result2 = numbers.iter().fold(0, |acc, &x| acc + x);
2031 /// // they're the same
2032 /// assert_eq!(result, result2);
2034 #[doc(alias = "reduce")]
2035 #[doc(alias = "inject")]
2037 #[stable(feature = "rust1", since = "1.0.0")]
2038 fn fold<B, F>(mut self, init: B, mut f: F) -> B
2041 F: FnMut(B, Self::Item) -> B,
2043 let mut accum = init;
2044 while let Some(x) = self.next() {
2045 accum = f(accum, x);
2050 /// The same as [`fold()`], but uses the first element in the
2051 /// iterator as the initial value, folding every subsequent element into it.
2052 /// If the iterator is empty, return [`None`]; otherwise, return the result
2055 /// [`fold()`]: Iterator::fold
2059 /// Find the maximum value:
2062 /// #![feature(iterator_fold_self)]
2064 /// fn find_max<I>(iter: I) -> Option<I::Item>
2065 /// where I: Iterator,
2068 /// iter.fold_first(|a, b| {
2069 /// if a >= b { a } else { b }
2072 /// let a = [10, 20, 5, -23, 0];
2073 /// let b: [u32; 0] = [];
2075 /// assert_eq!(find_max(a.iter()), Some(&20));
2076 /// assert_eq!(find_max(b.iter()), None);
2079 #[unstable(feature = "iterator_fold_self", issue = "68125")]
2080 fn fold_first<F>(mut self, f: F) -> Option<Self::Item>
2083 F: FnMut(Self::Item, Self::Item) -> Self::Item,
2085 let first = self.next()?;
2086 Some(self.fold(first, f))
2089 /// Tests if every element of the iterator matches a predicate.
2091 /// `all()` takes a closure that returns `true` or `false`. It applies
2092 /// this closure to each element of the iterator, and if they all return
2093 /// `true`, then so does `all()`. If any of them return `false`, it
2094 /// returns `false`.
2096 /// `all()` is short-circuiting; in other words, it will stop processing
2097 /// as soon as it finds a `false`, given that no matter what else happens,
2098 /// the result will also be `false`.
2100 /// An empty iterator returns `true`.
2107 /// let a = [1, 2, 3];
2109 /// assert!(a.iter().all(|&x| x > 0));
2111 /// assert!(!a.iter().all(|&x| x > 2));
2114 /// Stopping at the first `false`:
2117 /// let a = [1, 2, 3];
2119 /// let mut iter = a.iter();
2121 /// assert!(!iter.all(|&x| x != 2));
2123 /// // we can still use `iter`, as there are more elements.
2124 /// assert_eq!(iter.next(), Some(&3));
2127 #[stable(feature = "rust1", since = "1.0.0")]
2128 fn all<F>(&mut self, f: F) -> bool
2131 F: FnMut(Self::Item) -> bool,
2134 fn check<T>(mut f: impl FnMut(T) -> bool) -> impl FnMut((), T) -> ControlFlow<()> {
2136 if f(x) { ControlFlow::CONTINUE } else { ControlFlow::BREAK }
2139 self.try_fold((), check(f)) == ControlFlow::CONTINUE
2142 /// Tests if any element of the iterator matches a predicate.
2144 /// `any()` takes a closure that returns `true` or `false`. It applies
2145 /// this closure to each element of the iterator, and if any of them return
2146 /// `true`, then so does `any()`. If they all return `false`, it
2147 /// returns `false`.
2149 /// `any()` is short-circuiting; in other words, it will stop processing
2150 /// as soon as it finds a `true`, given that no matter what else happens,
2151 /// the result will also be `true`.
2153 /// An empty iterator returns `false`.
2160 /// let a = [1, 2, 3];
2162 /// assert!(a.iter().any(|&x| x > 0));
2164 /// assert!(!a.iter().any(|&x| x > 5));
2167 /// Stopping at the first `true`:
2170 /// let a = [1, 2, 3];
2172 /// let mut iter = a.iter();
2174 /// assert!(iter.any(|&x| x != 2));
2176 /// // we can still use `iter`, as there are more elements.
2177 /// assert_eq!(iter.next(), Some(&2));
2180 #[stable(feature = "rust1", since = "1.0.0")]
2181 fn any<F>(&mut self, f: F) -> bool
2184 F: FnMut(Self::Item) -> bool,
2187 fn check<T>(mut f: impl FnMut(T) -> bool) -> impl FnMut((), T) -> ControlFlow<()> {
2189 if f(x) { ControlFlow::BREAK } else { ControlFlow::CONTINUE }
2193 self.try_fold((), check(f)) == ControlFlow::BREAK
2196 /// Searches for an element of an iterator that satisfies a predicate.
2198 /// `find()` takes a closure that returns `true` or `false`. It applies
2199 /// this closure to each element of the iterator, and if any of them return
2200 /// `true`, then `find()` returns [`Some(element)`]. If they all return
2201 /// `false`, it returns [`None`].
2203 /// `find()` is short-circuiting; in other words, it will stop processing
2204 /// as soon as the closure returns `true`.
2206 /// Because `find()` takes a reference, and many iterators iterate over
2207 /// references, this leads to a possibly confusing situation where the
2208 /// argument is a double reference. You can see this effect in the
2209 /// examples below, with `&&x`.
2211 /// [`Some(element)`]: Some
2218 /// let a = [1, 2, 3];
2220 /// assert_eq!(a.iter().find(|&&x| x == 2), Some(&2));
2222 /// assert_eq!(a.iter().find(|&&x| x == 5), None);
2225 /// Stopping at the first `true`:
2228 /// let a = [1, 2, 3];
2230 /// let mut iter = a.iter();
2232 /// assert_eq!(iter.find(|&&x| x == 2), Some(&2));
2234 /// // we can still use `iter`, as there are more elements.
2235 /// assert_eq!(iter.next(), Some(&3));
2238 /// Note that `iter.find(f)` is equivalent to `iter.filter(f).next()`.
2240 #[stable(feature = "rust1", since = "1.0.0")]
2241 fn find<P>(&mut self, predicate: P) -> Option<Self::Item>
2244 P: FnMut(&Self::Item) -> bool,
2247 fn check<T>(mut predicate: impl FnMut(&T) -> bool) -> impl FnMut((), T) -> ControlFlow<T> {
2249 if predicate(&x) { ControlFlow::Break(x) } else { ControlFlow::CONTINUE }
2253 self.try_fold((), check(predicate)).break_value()
2256 /// Applies function to the elements of iterator and returns
2257 /// the first non-none result.
2259 /// `iter.find_map(f)` is equivalent to `iter.filter_map(f).next()`.
2264 /// let a = ["lol", "NaN", "2", "5"];
2266 /// let first_number = a.iter().find_map(|s| s.parse().ok());
2268 /// assert_eq!(first_number, Some(2));
2271 #[stable(feature = "iterator_find_map", since = "1.30.0")]
2272 fn find_map<B, F>(&mut self, f: F) -> Option<B>
2275 F: FnMut(Self::Item) -> Option<B>,
2278 fn check<T, B>(mut f: impl FnMut(T) -> Option<B>) -> impl FnMut((), T) -> ControlFlow<B> {
2279 move |(), x| match f(x) {
2280 Some(x) => ControlFlow::Break(x),
2281 None => ControlFlow::CONTINUE,
2285 self.try_fold((), check(f)).break_value()
2288 /// Applies function to the elements of iterator and returns
2289 /// the first true result or the first error.
2294 /// #![feature(try_find)]
2296 /// let a = ["1", "2", "lol", "NaN", "5"];
2298 /// let is_my_num = |s: &str, search: i32| -> Result<bool, std::num::ParseIntError> {
2299 /// Ok(s.parse::<i32>()? == search)
2302 /// let result = a.iter().try_find(|&&s| is_my_num(s, 2));
2303 /// assert_eq!(result, Ok(Some(&"2")));
2305 /// let result = a.iter().try_find(|&&s| is_my_num(s, 5));
2306 /// assert!(result.is_err());
2309 #[unstable(feature = "try_find", reason = "new API", issue = "63178")]
2310 fn try_find<F, R>(&mut self, f: F) -> Result<Option<Self::Item>, R::Error>
2313 F: FnMut(&Self::Item) -> R,
2317 fn check<F, T, R>(mut f: F) -> impl FnMut((), T) -> ControlFlow<Result<T, R::Error>>
2322 move |(), x| match f(&x).into_result() {
2323 Ok(false) => ControlFlow::CONTINUE,
2324 Ok(true) => ControlFlow::Break(Ok(x)),
2325 Err(x) => ControlFlow::Break(Err(x)),
2329 self.try_fold((), check(f)).break_value().transpose()
2332 /// Searches for an element in an iterator, returning its index.
2334 /// `position()` takes a closure that returns `true` or `false`. It applies
2335 /// this closure to each element of the iterator, and if one of them
2336 /// returns `true`, then `position()` returns [`Some(index)`]. If all of
2337 /// them return `false`, it returns [`None`].
2339 /// `position()` is short-circuiting; in other words, it will stop
2340 /// processing as soon as it finds a `true`.
2342 /// # Overflow Behavior
2344 /// The method does no guarding against overflows, so if there are more
2345 /// than [`usize::MAX`] non-matching elements, it either produces the wrong
2346 /// result or panics. If debug assertions are enabled, a panic is
2351 /// This function might panic if the iterator has more than `usize::MAX`
2352 /// non-matching elements.
2354 /// [`Some(index)`]: Some
2355 /// [`usize::MAX`]: crate::usize::MAX
2362 /// let a = [1, 2, 3];
2364 /// assert_eq!(a.iter().position(|&x| x == 2), Some(1));
2366 /// assert_eq!(a.iter().position(|&x| x == 5), None);
2369 /// Stopping at the first `true`:
2372 /// let a = [1, 2, 3, 4];
2374 /// let mut iter = a.iter();
2376 /// assert_eq!(iter.position(|&x| x >= 2), Some(1));
2378 /// // we can still use `iter`, as there are more elements.
2379 /// assert_eq!(iter.next(), Some(&3));
2381 /// // The returned index depends on iterator state
2382 /// assert_eq!(iter.position(|&x| x == 4), Some(0));
2386 #[stable(feature = "rust1", since = "1.0.0")]
2387 fn position<P>(&mut self, predicate: P) -> Option<usize>
2390 P: FnMut(Self::Item) -> bool,
2394 mut predicate: impl FnMut(T) -> bool,
2395 ) -> impl FnMut(usize, T) -> ControlFlow<usize, usize> {
2396 // The addition might panic on overflow
2399 ControlFlow::Break(i)
2401 ControlFlow::Continue(Add::add(i, 1))
2406 self.try_fold(0, check(predicate)).break_value()
2409 /// Searches for an element in an iterator from the right, returning its
2412 /// `rposition()` takes a closure that returns `true` or `false`. It applies
2413 /// this closure to each element of the iterator, starting from the end,
2414 /// and if one of them returns `true`, then `rposition()` returns
2415 /// [`Some(index)`]. If all of them return `false`, it returns [`None`].
2417 /// `rposition()` is short-circuiting; in other words, it will stop
2418 /// processing as soon as it finds a `true`.
2420 /// [`Some(index)`]: Some
2427 /// let a = [1, 2, 3];
2429 /// assert_eq!(a.iter().rposition(|&x| x == 3), Some(2));
2431 /// assert_eq!(a.iter().rposition(|&x| x == 5), None);
2434 /// Stopping at the first `true`:
2437 /// let a = [1, 2, 3];
2439 /// let mut iter = a.iter();
2441 /// assert_eq!(iter.rposition(|&x| x == 2), Some(1));
2443 /// // we can still use `iter`, as there are more elements.
2444 /// assert_eq!(iter.next(), Some(&1));
2447 #[stable(feature = "rust1", since = "1.0.0")]
2448 fn rposition<P>(&mut self, predicate: P) -> Option<usize>
2450 P: FnMut(Self::Item) -> bool,
2451 Self: Sized + ExactSizeIterator + DoubleEndedIterator,
2453 // No need for an overflow check here, because `ExactSizeIterator`
2454 // implies that the number of elements fits into a `usize`.
2457 mut predicate: impl FnMut(T) -> bool,
2458 ) -> impl FnMut(usize, T) -> ControlFlow<usize, usize> {
2461 if predicate(x) { ControlFlow::Break(i) } else { ControlFlow::Continue(i) }
2466 self.try_rfold(n, check(predicate)).break_value()
2469 /// Returns the maximum element of an iterator.
2471 /// If several elements are equally maximum, the last element is
2472 /// returned. If the iterator is empty, [`None`] is returned.
2479 /// let a = [1, 2, 3];
2480 /// let b: Vec<u32> = Vec::new();
2482 /// assert_eq!(a.iter().max(), Some(&3));
2483 /// assert_eq!(b.iter().max(), None);
2486 #[stable(feature = "rust1", since = "1.0.0")]
2487 fn max(self) -> Option<Self::Item>
2492 self.max_by(Ord::cmp)
2495 /// Returns the minimum element of an iterator.
2497 /// If several elements are equally minimum, the first element is
2498 /// returned. If the iterator is empty, [`None`] is returned.
2505 /// let a = [1, 2, 3];
2506 /// let b: Vec<u32> = Vec::new();
2508 /// assert_eq!(a.iter().min(), Some(&1));
2509 /// assert_eq!(b.iter().min(), None);
2512 #[stable(feature = "rust1", since = "1.0.0")]
2513 fn min(self) -> Option<Self::Item>
2518 self.min_by(Ord::cmp)
2521 /// Returns the element that gives the maximum value from the
2522 /// specified function.
2524 /// If several elements are equally maximum, the last element is
2525 /// returned. If the iterator is empty, [`None`] is returned.
2530 /// let a = [-3_i32, 0, 1, 5, -10];
2531 /// assert_eq!(*a.iter().max_by_key(|x| x.abs()).unwrap(), -10);
2534 #[stable(feature = "iter_cmp_by_key", since = "1.6.0")]
2535 fn max_by_key<B: Ord, F>(self, f: F) -> Option<Self::Item>
2538 F: FnMut(&Self::Item) -> B,
2541 fn key<T, B>(mut f: impl FnMut(&T) -> B) -> impl FnMut(T) -> (B, T) {
2546 fn compare<T, B: Ord>((x_p, _): &(B, T), (y_p, _): &(B, T)) -> Ordering {
2550 let (_, x) = self.map(key(f)).max_by(compare)?;
2554 /// Returns the element that gives the maximum value with respect to the
2555 /// specified comparison function.
2557 /// If several elements are equally maximum, the last element is
2558 /// returned. If the iterator is empty, [`None`] is returned.
2563 /// let a = [-3_i32, 0, 1, 5, -10];
2564 /// assert_eq!(*a.iter().max_by(|x, y| x.cmp(y)).unwrap(), 5);
2567 #[stable(feature = "iter_max_by", since = "1.15.0")]
2568 fn max_by<F>(self, compare: F) -> Option<Self::Item>
2571 F: FnMut(&Self::Item, &Self::Item) -> Ordering,
2574 fn fold<T>(mut compare: impl FnMut(&T, &T) -> Ordering) -> impl FnMut(T, T) -> T {
2575 move |x, y| cmp::max_by(x, y, &mut compare)
2578 self.fold_first(fold(compare))
2581 /// Returns the element that gives the minimum value from the
2582 /// specified function.
2584 /// If several elements are equally minimum, the first element is
2585 /// returned. If the iterator is empty, [`None`] is returned.
2590 /// let a = [-3_i32, 0, 1, 5, -10];
2591 /// assert_eq!(*a.iter().min_by_key(|x| x.abs()).unwrap(), 0);
2594 #[stable(feature = "iter_cmp_by_key", since = "1.6.0")]
2595 fn min_by_key<B: Ord, F>(self, f: F) -> Option<Self::Item>
2598 F: FnMut(&Self::Item) -> B,
2601 fn key<T, B>(mut f: impl FnMut(&T) -> B) -> impl FnMut(T) -> (B, T) {
2606 fn compare<T, B: Ord>((x_p, _): &(B, T), (y_p, _): &(B, T)) -> Ordering {
2610 let (_, x) = self.map(key(f)).min_by(compare)?;
2614 /// Returns the element that gives the minimum value with respect to the
2615 /// specified comparison function.
2617 /// If several elements are equally minimum, the first element is
2618 /// returned. If the iterator is empty, [`None`] is returned.
2623 /// let a = [-3_i32, 0, 1, 5, -10];
2624 /// assert_eq!(*a.iter().min_by(|x, y| x.cmp(y)).unwrap(), -10);
2627 #[stable(feature = "iter_min_by", since = "1.15.0")]
2628 fn min_by<F>(self, compare: F) -> Option<Self::Item>
2631 F: FnMut(&Self::Item, &Self::Item) -> Ordering,
2634 fn fold<T>(mut compare: impl FnMut(&T, &T) -> Ordering) -> impl FnMut(T, T) -> T {
2635 move |x, y| cmp::min_by(x, y, &mut compare)
2638 self.fold_first(fold(compare))
2641 /// Reverses an iterator's direction.
2643 /// Usually, iterators iterate from left to right. After using `rev()`,
2644 /// an iterator will instead iterate from right to left.
2646 /// This is only possible if the iterator has an end, so `rev()` only
2647 /// works on [`DoubleEndedIterator`]s.
2652 /// let a = [1, 2, 3];
2654 /// let mut iter = a.iter().rev();
2656 /// assert_eq!(iter.next(), Some(&3));
2657 /// assert_eq!(iter.next(), Some(&2));
2658 /// assert_eq!(iter.next(), Some(&1));
2660 /// assert_eq!(iter.next(), None);
2663 #[stable(feature = "rust1", since = "1.0.0")]
2664 fn rev(self) -> Rev<Self>
2666 Self: Sized + DoubleEndedIterator,
2671 /// Converts an iterator of pairs into a pair of containers.
2673 /// `unzip()` consumes an entire iterator of pairs, producing two
2674 /// collections: one from the left elements of the pairs, and one
2675 /// from the right elements.
2677 /// This function is, in some sense, the opposite of [`zip`].
2679 /// [`zip`]: Iterator::zip
2686 /// let a = [(1, 2), (3, 4)];
2688 /// let (left, right): (Vec<_>, Vec<_>) = a.iter().cloned().unzip();
2690 /// assert_eq!(left, [1, 3]);
2691 /// assert_eq!(right, [2, 4]);
2693 #[stable(feature = "rust1", since = "1.0.0")]
2694 fn unzip<A, B, FromA, FromB>(self) -> (FromA, FromB)
2696 FromA: Default + Extend<A>,
2697 FromB: Default + Extend<B>,
2698 Self: Sized + Iterator<Item = (A, B)>,
2700 fn extend<'a, A, B>(
2701 ts: &'a mut impl Extend<A>,
2702 us: &'a mut impl Extend<B>,
2703 ) -> impl FnMut((), (A, B)) + 'a {
2710 let mut ts: FromA = Default::default();
2711 let mut us: FromB = Default::default();
2713 let (lower_bound, _) = self.size_hint();
2714 if lower_bound > 0 {
2715 ts.extend_reserve(lower_bound);
2716 us.extend_reserve(lower_bound);
2719 self.fold((), extend(&mut ts, &mut us));
2724 /// Creates an iterator which copies all of its elements.
2726 /// This is useful when you have an iterator over `&T`, but you need an
2727 /// iterator over `T`.
2734 /// let a = [1, 2, 3];
2736 /// let v_copied: Vec<_> = a.iter().copied().collect();
2738 /// // copied is the same as .map(|&x| x)
2739 /// let v_map: Vec<_> = a.iter().map(|&x| x).collect();
2741 /// assert_eq!(v_copied, vec![1, 2, 3]);
2742 /// assert_eq!(v_map, vec![1, 2, 3]);
2744 #[stable(feature = "iter_copied", since = "1.36.0")]
2745 fn copied<'a, T: 'a>(self) -> Copied<Self>
2747 Self: Sized + Iterator<Item = &'a T>,
2753 /// Creates an iterator which [`clone`]s all of its elements.
2755 /// This is useful when you have an iterator over `&T`, but you need an
2756 /// iterator over `T`.
2758 /// [`clone`]: Clone::clone
2765 /// let a = [1, 2, 3];
2767 /// let v_cloned: Vec<_> = a.iter().cloned().collect();
2769 /// // cloned is the same as .map(|&x| x), for integers
2770 /// let v_map: Vec<_> = a.iter().map(|&x| x).collect();
2772 /// assert_eq!(v_cloned, vec![1, 2, 3]);
2773 /// assert_eq!(v_map, vec![1, 2, 3]);
2775 #[stable(feature = "rust1", since = "1.0.0")]
2776 fn cloned<'a, T: 'a>(self) -> Cloned<Self>
2778 Self: Sized + Iterator<Item = &'a T>,
2784 /// Repeats an iterator endlessly.
2786 /// Instead of stopping at [`None`], the iterator will instead start again,
2787 /// from the beginning. After iterating again, it will start at the
2788 /// beginning again. And again. And again. Forever.
2795 /// let a = [1, 2, 3];
2797 /// let mut it = a.iter().cycle();
2799 /// assert_eq!(it.next(), Some(&1));
2800 /// assert_eq!(it.next(), Some(&2));
2801 /// assert_eq!(it.next(), Some(&3));
2802 /// assert_eq!(it.next(), Some(&1));
2803 /// assert_eq!(it.next(), Some(&2));
2804 /// assert_eq!(it.next(), Some(&3));
2805 /// assert_eq!(it.next(), Some(&1));
2807 #[stable(feature = "rust1", since = "1.0.0")]
2809 fn cycle(self) -> Cycle<Self>
2811 Self: Sized + Clone,
2816 /// Sums the elements of an iterator.
2818 /// Takes each element, adds them together, and returns the result.
2820 /// An empty iterator returns the zero value of the type.
2824 /// When calling `sum()` and a primitive integer type is being returned, this
2825 /// method will panic if the computation overflows and debug assertions are
2833 /// let a = [1, 2, 3];
2834 /// let sum: i32 = a.iter().sum();
2836 /// assert_eq!(sum, 6);
2838 #[stable(feature = "iter_arith", since = "1.11.0")]
2839 fn sum<S>(self) -> S
2847 /// Iterates over the entire iterator, multiplying all the elements
2849 /// An empty iterator returns the one value of the type.
2853 /// When calling `product()` and a primitive integer type is being returned,
2854 /// method will panic if the computation overflows and debug assertions are
2860 /// fn factorial(n: u32) -> u32 {
2861 /// (1..=n).product()
2863 /// assert_eq!(factorial(0), 1);
2864 /// assert_eq!(factorial(1), 1);
2865 /// assert_eq!(factorial(5), 120);
2867 #[stable(feature = "iter_arith", since = "1.11.0")]
2868 fn product<P>(self) -> P
2871 P: Product<Self::Item>,
2873 Product::product(self)
2876 /// [Lexicographically](Ord#lexicographical-comparison) compares the elements of this [`Iterator`] with those
2882 /// use std::cmp::Ordering;
2884 /// assert_eq!([1].iter().cmp([1].iter()), Ordering::Equal);
2885 /// assert_eq!([1].iter().cmp([1, 2].iter()), Ordering::Less);
2886 /// assert_eq!([1, 2].iter().cmp([1].iter()), Ordering::Greater);
2888 #[stable(feature = "iter_order", since = "1.5.0")]
2889 fn cmp<I>(self, other: I) -> Ordering
2891 I: IntoIterator<Item = Self::Item>,
2895 self.cmp_by(other, |x, y| x.cmp(&y))
2898 /// [Lexicographically](Ord#lexicographical-comparison) compares the elements of this [`Iterator`] with those
2899 /// of another with respect to the specified comparison function.
2906 /// #![feature(iter_order_by)]
2908 /// use std::cmp::Ordering;
2910 /// let xs = [1, 2, 3, 4];
2911 /// let ys = [1, 4, 9, 16];
2913 /// assert_eq!(xs.iter().cmp_by(&ys, |&x, &y| x.cmp(&y)), Ordering::Less);
2914 /// assert_eq!(xs.iter().cmp_by(&ys, |&x, &y| (x * x).cmp(&y)), Ordering::Equal);
2915 /// assert_eq!(xs.iter().cmp_by(&ys, |&x, &y| (2 * x).cmp(&y)), Ordering::Greater);
2917 #[unstable(feature = "iter_order_by", issue = "64295")]
2918 fn cmp_by<I, F>(mut self, other: I, mut cmp: F) -> Ordering
2922 F: FnMut(Self::Item, I::Item) -> Ordering,
2924 let mut other = other.into_iter();
2927 let x = match self.next() {
2929 if other.next().is_none() {
2930 return Ordering::Equal;
2932 return Ordering::Less;
2938 let y = match other.next() {
2939 None => return Ordering::Greater,
2944 Ordering::Equal => (),
2945 non_eq => return non_eq,
2950 /// [Lexicographically](Ord#lexicographical-comparison) compares the elements of this [`Iterator`] with those
2956 /// use std::cmp::Ordering;
2958 /// assert_eq!([1.].iter().partial_cmp([1.].iter()), Some(Ordering::Equal));
2959 /// assert_eq!([1.].iter().partial_cmp([1., 2.].iter()), Some(Ordering::Less));
2960 /// assert_eq!([1., 2.].iter().partial_cmp([1.].iter()), Some(Ordering::Greater));
2962 /// assert_eq!([f64::NAN].iter().partial_cmp([1.].iter()), None);
2964 #[stable(feature = "iter_order", since = "1.5.0")]
2965 fn partial_cmp<I>(self, other: I) -> Option<Ordering>
2968 Self::Item: PartialOrd<I::Item>,
2971 self.partial_cmp_by(other, |x, y| x.partial_cmp(&y))
2974 /// [Lexicographically](Ord#lexicographical-comparison) compares the elements of this [`Iterator`] with those
2975 /// of another with respect to the specified comparison function.
2982 /// #![feature(iter_order_by)]
2984 /// use std::cmp::Ordering;
2986 /// let xs = [1.0, 2.0, 3.0, 4.0];
2987 /// let ys = [1.0, 4.0, 9.0, 16.0];
2990 /// xs.iter().partial_cmp_by(&ys, |&x, &y| x.partial_cmp(&y)),
2991 /// Some(Ordering::Less)
2994 /// xs.iter().partial_cmp_by(&ys, |&x, &y| (x * x).partial_cmp(&y)),
2995 /// Some(Ordering::Equal)
2998 /// xs.iter().partial_cmp_by(&ys, |&x, &y| (2.0 * x).partial_cmp(&y)),
2999 /// Some(Ordering::Greater)
3002 #[unstable(feature = "iter_order_by", issue = "64295")]
3003 fn partial_cmp_by<I, F>(mut self, other: I, mut partial_cmp: F) -> Option<Ordering>
3007 F: FnMut(Self::Item, I::Item) -> Option<Ordering>,
3009 let mut other = other.into_iter();
3012 let x = match self.next() {
3014 if other.next().is_none() {
3015 return Some(Ordering::Equal);
3017 return Some(Ordering::Less);
3023 let y = match other.next() {
3024 None => return Some(Ordering::Greater),
3028 match partial_cmp(x, y) {
3029 Some(Ordering::Equal) => (),
3030 non_eq => return non_eq,
3035 /// Determines if the elements of this [`Iterator`] are equal to those of
3041 /// assert_eq!([1].iter().eq([1].iter()), true);
3042 /// assert_eq!([1].iter().eq([1, 2].iter()), false);
3044 #[stable(feature = "iter_order", since = "1.5.0")]
3045 fn eq<I>(self, other: I) -> bool
3048 Self::Item: PartialEq<I::Item>,
3051 self.eq_by(other, |x, y| x == y)
3054 /// Determines if the elements of this [`Iterator`] are equal to those of
3055 /// another with respect to the specified equality function.
3062 /// #![feature(iter_order_by)]
3064 /// let xs = [1, 2, 3, 4];
3065 /// let ys = [1, 4, 9, 16];
3067 /// assert!(xs.iter().eq_by(&ys, |&x, &y| x * x == y));
3069 #[unstable(feature = "iter_order_by", issue = "64295")]
3070 fn eq_by<I, F>(mut self, other: I, mut eq: F) -> bool
3074 F: FnMut(Self::Item, I::Item) -> bool,
3076 let mut other = other.into_iter();
3079 let x = match self.next() {
3080 None => return other.next().is_none(),
3084 let y = match other.next() {
3085 None => return false,
3095 /// Determines if the elements of this [`Iterator`] are unequal to those of
3101 /// assert_eq!([1].iter().ne([1].iter()), false);
3102 /// assert_eq!([1].iter().ne([1, 2].iter()), true);
3104 #[stable(feature = "iter_order", since = "1.5.0")]
3105 fn ne<I>(self, other: I) -> bool
3108 Self::Item: PartialEq<I::Item>,
3114 /// Determines if the elements of this [`Iterator`] are [lexicographically](Ord#lexicographical-comparison)
3115 /// less than those of another.
3120 /// assert_eq!([1].iter().lt([1].iter()), false);
3121 /// assert_eq!([1].iter().lt([1, 2].iter()), true);
3122 /// assert_eq!([1, 2].iter().lt([1].iter()), false);
3123 /// assert_eq!([1, 2].iter().lt([1, 2].iter()), false);
3125 #[stable(feature = "iter_order", since = "1.5.0")]
3126 fn lt<I>(self, other: I) -> bool
3129 Self::Item: PartialOrd<I::Item>,
3132 self.partial_cmp(other) == Some(Ordering::Less)
3135 /// Determines if the elements of this [`Iterator`] are [lexicographically](Ord#lexicographical-comparison)
3136 /// less or equal to those of another.
3141 /// assert_eq!([1].iter().le([1].iter()), true);
3142 /// assert_eq!([1].iter().le([1, 2].iter()), true);
3143 /// assert_eq!([1, 2].iter().le([1].iter()), false);
3144 /// assert_eq!([1, 2].iter().le([1, 2].iter()), true);
3146 #[stable(feature = "iter_order", since = "1.5.0")]
3147 fn le<I>(self, other: I) -> bool
3150 Self::Item: PartialOrd<I::Item>,
3153 matches!(self.partial_cmp(other), Some(Ordering::Less | Ordering::Equal))
3156 /// Determines if the elements of this [`Iterator`] are [lexicographically](Ord#lexicographical-comparison)
3157 /// greater than those of another.
3162 /// assert_eq!([1].iter().gt([1].iter()), false);
3163 /// assert_eq!([1].iter().gt([1, 2].iter()), false);
3164 /// assert_eq!([1, 2].iter().gt([1].iter()), true);
3165 /// assert_eq!([1, 2].iter().gt([1, 2].iter()), false);
3167 #[stable(feature = "iter_order", since = "1.5.0")]
3168 fn gt<I>(self, other: I) -> bool
3171 Self::Item: PartialOrd<I::Item>,
3174 self.partial_cmp(other) == Some(Ordering::Greater)
3177 /// Determines if the elements of this [`Iterator`] are [lexicographically](Ord#lexicographical-comparison)
3178 /// greater than or equal to those of another.
3183 /// assert_eq!([1].iter().ge([1].iter()), true);
3184 /// assert_eq!([1].iter().ge([1, 2].iter()), false);
3185 /// assert_eq!([1, 2].iter().ge([1].iter()), true);
3186 /// assert_eq!([1, 2].iter().ge([1, 2].iter()), true);
3188 #[stable(feature = "iter_order", since = "1.5.0")]
3189 fn ge<I>(self, other: I) -> bool
3192 Self::Item: PartialOrd<I::Item>,
3195 matches!(self.partial_cmp(other), Some(Ordering::Greater | Ordering::Equal))
3198 /// Checks if the elements of this iterator are sorted.
3200 /// That is, for each element `a` and its following element `b`, `a <= b` must hold. If the
3201 /// iterator yields exactly zero or one element, `true` is returned.
3203 /// Note that if `Self::Item` is only `PartialOrd`, but not `Ord`, the above definition
3204 /// implies that this function returns `false` if any two consecutive items are not
3210 /// #![feature(is_sorted)]
3212 /// assert!([1, 2, 2, 9].iter().is_sorted());
3213 /// assert!(![1, 3, 2, 4].iter().is_sorted());
3214 /// assert!([0].iter().is_sorted());
3215 /// assert!(std::iter::empty::<i32>().is_sorted());
3216 /// assert!(![0.0, 1.0, f32::NAN].iter().is_sorted());
3219 #[unstable(feature = "is_sorted", reason = "new API", issue = "53485")]
3220 fn is_sorted(self) -> bool
3223 Self::Item: PartialOrd,
3225 self.is_sorted_by(PartialOrd::partial_cmp)
3228 /// Checks if the elements of this iterator are sorted using the given comparator function.
3230 /// Instead of using `PartialOrd::partial_cmp`, this function uses the given `compare`
3231 /// function to determine the ordering of two elements. Apart from that, it's equivalent to
3232 /// [`is_sorted`]; see its documentation for more information.
3237 /// #![feature(is_sorted)]
3239 /// assert!([1, 2, 2, 9].iter().is_sorted_by(|a, b| a.partial_cmp(b)));
3240 /// assert!(![1, 3, 2, 4].iter().is_sorted_by(|a, b| a.partial_cmp(b)));
3241 /// assert!([0].iter().is_sorted_by(|a, b| a.partial_cmp(b)));
3242 /// assert!(std::iter::empty::<i32>().is_sorted_by(|a, b| a.partial_cmp(b)));
3243 /// assert!(![0.0, 1.0, f32::NAN].iter().is_sorted_by(|a, b| a.partial_cmp(b)));
3246 /// [`is_sorted`]: Iterator::is_sorted
3247 #[unstable(feature = "is_sorted", reason = "new API", issue = "53485")]
3248 fn is_sorted_by<F>(mut self, mut compare: F) -> bool
3251 F: FnMut(&Self::Item, &Self::Item) -> Option<Ordering>,
3253 let mut last = match self.next() {
3255 None => return true,
3258 while let Some(curr) = self.next() {
3259 if let Some(Ordering::Greater) | None = compare(&last, &curr) {
3268 /// Checks if the elements of this iterator are sorted using the given key extraction
3271 /// Instead of comparing the iterator's elements directly, this function compares the keys of
3272 /// the elements, as determined by `f`. Apart from that, it's equivalent to [`is_sorted`]; see
3273 /// its documentation for more information.
3275 /// [`is_sorted`]: Iterator::is_sorted
3280 /// #![feature(is_sorted)]
3282 /// assert!(["c", "bb", "aaa"].iter().is_sorted_by_key(|s| s.len()));
3283 /// assert!(![-2i32, -1, 0, 3].iter().is_sorted_by_key(|n| n.abs()));
3286 #[unstable(feature = "is_sorted", reason = "new API", issue = "53485")]
3287 fn is_sorted_by_key<F, K>(self, f: F) -> bool
3290 F: FnMut(Self::Item) -> K,
3293 self.map(f).is_sorted()
3296 /// See [TrustedRandomAccess]
3297 // The unusual name is to avoid name collisions in method resolution
3301 #[unstable(feature = "trusted_random_access", issue = "none")]
3302 unsafe fn __iterator_get_unchecked(&mut self, _idx: usize) -> Self::Item
3304 Self: TrustedRandomAccess,
3306 unreachable!("Always specialized");
3310 #[stable(feature = "rust1", since = "1.0.0")]
3311 impl<I: Iterator + ?Sized> Iterator for &mut I {
3312 type Item = I::Item;
3313 fn next(&mut self) -> Option<I::Item> {
3316 fn size_hint(&self) -> (usize, Option<usize>) {
3317 (**self).size_hint()
3319 fn advance_by(&mut self, n: usize) -> Result<(), usize> {
3320 (**self).advance_by(n)
3322 fn nth(&mut self, n: usize) -> Option<Self::Item> {