Skip to content

Add Iterator::enumerate_from(self, first: usize) #45833

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 48 additions & 0 deletions src/libcore/iter/iterator.rs
Original file line number Diff line number Diff line change
Expand Up @@ -660,6 +660,11 @@ pub trait Iterator {
/// current index of iteration and `val` is the value returned by the
/// iterator.
///
/// The index of iteration starts at zero.
/// To count from a different value, see [`enumerate_from`].
///
/// [`enumerate_from`]: ../../std/iter/trait.Iterator.html#method.enumerate_from
///
/// `enumerate()` keeps its count as a [`usize`]. If you want to count by a
/// different sized integer, the [`zip`] function provides similar
/// functionality.
Expand Down Expand Up @@ -697,6 +702,49 @@ pub trait Iterator {
Enumerate { iter: self, count: 0 }
}

/// Creates an iterator which gives the current iteration count,
/// starting with `first`,
/// as well as the next value.
///
/// When `first` is zero this is equivalent to [`enumerate`].
///
/// [`enumerate`]: ../../std/iter/trait.Iterator.html#method.enumerate
///
/// # Overflow Behavior
///
/// The method does no guarding against overflows, so enumerating
/// beyond index [`usize::MAX`] either produces the wrong result or panics.
/// If debug assertions are enabled, a panic is guaranteed.
///
/// # Panics
///
/// The returned iterator might panic if the to-be-returned index would
/// overflow a [`usize`].
///
/// [`usize::MAX`]: ../../std/usize/constant.MAX.html
/// [`usize`]: ../../std/primitive.usize.html
/// [`zip`]: #method.zip
///
/// # Examples
///
/// ```
/// #![feature(enumerate_from)]
///
/// let a = ['a', 'b', 'c'];
///
/// let mut iter = a.iter().enumerate_from(1);
///
/// assert_eq!(iter.next(), Some((1, &'a')));
/// assert_eq!(iter.next(), Some((2, &'b')));
/// assert_eq!(iter.next(), Some((3, &'c')));
/// assert_eq!(iter.next(), None);
/// ```
#[inline]
#[unstable(feature = "enumerate_from", issue = /* FIXME */ "0")]
fn enumerate_from(self, first: usize) -> Enumerate<Self> where Self: Sized {
Enumerate { iter: self, count: first }
}

/// Creates an iterator which can use `peek` to look at the next element of
/// the iterator without consuming it.
///
Expand Down
9 changes: 9 additions & 0 deletions src/libcore/tests/iter.rs
Original file line number Diff line number Diff line change
Expand Up @@ -276,6 +276,15 @@ fn test_iterator_enumerate() {
}
}

#[test]
fn test_iterator_enumerate_from() {
let xs = [2, 3, 4, 5];
let it = xs.iter().enumerate_from(2);
for (i, &x) in it {
assert_eq!(i, x);
}
}

#[test]
fn test_iterator_enumerate_nth() {
let xs = [0, 1, 2, 3, 4, 5];
Expand Down
1 change: 1 addition & 0 deletions src/libcore/tests/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
#![feature(core_private_diy_float)]
#![feature(dec2flt)]
#![feature(decode_utf8)]
#![feature(enumerate_from)]
#![feature(exact_size_is_empty)]
#![feature(fixed_size_array)]
#![feature(flt2dec)]
Expand Down