OpenE2K/rust
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

iterator docs: Move paragraph about discarding; clarify "consumed"

Browse Source
This commit is contained in:
Rob Speer 2017-02-10 01:35:29 -05:00
parent ebf29ef073
commit 11d36aec83
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/libcore/iter/iterator.rs
View File

@ -209,14 +209,14 @@ pub trait Iterator {
/// Returns the `n`th element of the iterator.
///
/// Note that all preceding elements, as well as the returned element, will be
/// consumed. 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.
///
/// 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.
///