doc: add Iterator::size_hint example #28028
Merged
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
|
(rust_highfive has picked a reviewer for you, use r? to override) |
| /// | ||
| /// ``` | ||
| /// let a = [1, 2, 3, 4, 5]; | ||
| /// assert_eq!((5, Some(5)), a.iter().size_hint()); |
There was a problem hiding this comment.
It is not good example at all. While in practice this particular iterator over this particular data type will always return the exact size bounds, the purpose of this method (as the name implies) is for it to act as a hint. None of that hint-ness is reflected in this example.
Perhaps various iterator adaptors would make the hint more interesting and fitting? For example:
let iterator = (0..10).filter(|x| x % 2 == 0).chain(15..20);
iterator.size_hint() // returns (5, Some(15)) and the actual length of 10 is indeed in-bounds.
bors
added a commit
that referenced
this pull request
Aug 27, 2015
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.
No description provided.