docs: Add example to Iterator::take with by_ref
#139780
Open
+18
−0
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
If you want to logically split an iterator after `n` items, you might first discover `take`. Before this change, you'd find that `take` consumes the iterator, and you'd probably be stuck. The answer involves `by_ref`, but that's hard to discover, especially since `by_ref` is a bit abstract and `Iterator` has many methods. After this change, you'd see the example showing `take` along with `by_ref`, which allows you to continue using the rest of the iterator. `by_ref` had a good example involving `take` already, so this change just duplicates that existing example under `take`.
|
rustbot has assigned @workingjubilee. Use |
rustbot
added
S-waiting-on-review
|
Fun fact: the last time I submitted a PR to Rust was in 2013! https://github.com/rust-lang/rust/pulls?q=author%3Aongardie |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
If you want to logically split an iterator after
nitems, you might first discovertake. Before this change, you'd find thattakeconsumes the iterator, and you'd probably be stuck. The answer involvesby_ref, but that's hard to discover, especially sinceby_refis a bit abstract andIteratorhas many methods.After this change, you'd see the example showing
takealong withby_ref, which allows you to continue using the rest of the iterator.by_refhad a good example involvingtakealready, so this change just duplicates that existing example undertake.