Skip to content
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.

Sign up for GitHub

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

Fix a misleading statement in Iterator.nth() #39174

Merged
merged 3 commits into from
Feb 11, 2017
Merged

Fix a misleading statement in Iterator.nth() #39174

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5cc5e08
Fix a misleading statement in `Iterator.nth()`
Jan 19, 2017
ebf29ef
Rephrase my proposed edit ("objects" -> "elements")
Jan 19, 2017
11d36ae
iterator docs: Move paragraph about discarding; clarify "consumed"
Feb 10, 2017
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
7 changes: 5 additions & 2 deletions src/libcore/iter/iterator.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,11 +209,14 @@ pub trait Iterator {

/// Returns the `n`th element of the iterator.
///
/// Note that all preceding elements will be consumed (i.e. discarded).
///
/// Like most indexing operations, the count starts from zero, so `nth(0)`
/// returns the first value, `nth(1)` the second, and so on.
///
/// Note that all preceding elements, as well as the returned element, will be
/// consumed from the iterator. That means that the preceding elements will be
/// discarded, and also that calling `nth(0)` multiple times on the same iterator
/// will return different elements.
///
/// `nth()` will return [`None`] if `n` is greater than or equal to the length of the
/// iterator.
///
Expand Down