Expand documentation of Iterator::take and skip

This commit is contained in:
Kornel 2021-03-18 18:43:08 +00:00
parent 9d0446f1a7
commit 6cfdc385a1

View File

@ -1228,7 +1228,11 @@ fn map_while<B, P>(self, predicate: P) -> MapWhile<Self, P>
/// Creates an iterator that skips the first `n` elements.
///
/// After they have been consumed, the rest of the elements are yielded.
/// `skip(n)` skips elements until `n` elements are skipped or the end of the
/// iterator is reached (whichever happens first). After that, all the remaining
/// elements are yielded. In particular, if the original iterator is too short,
/// then the returned iterator is empty.
///
/// Rather than overriding this method directly, instead override the `nth` method.
///
/// # Examples
@ -1252,7 +1256,14 @@ fn skip(self, n: usize) -> Skip<Self>
Skip::new(self, n)
}
/// Creates an iterator that yields its first `n` elements.
/// Creates an iterator that yields the first `n` elements, or fewer
/// if the underlying iterator ends sooner.
///
/// `take(n)` yields elements until `n` elements are yielded or the end of
/// the iterator is reached (whichever happens first).
/// The returned iterator is a prefix of length `n` if the original iterator
/// contains at least `n` elements, otherwise it contains all of the
/// (fewer than `n`) elements of the original iterator.
///
/// # Examples
///