add perf side effect docs to Iterator::cloned()
#92955
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
|
r? @yaahc (rust-highfive has picked a reviewer for you, use r? to override) |
rust-highfive
added
the
S-waiting-on-review
This comment has been minimized.
This comment has been minimized.
scottmcm
added
S-waiting-on-author
leonardo-m
reviewed
Jan 16, 2022
llogiq
force-pushed
the
cloned-side-effect-doc
branch
from
37d0146
to
d7006fe
Compare
This comment has been minimized.
This comment has been minimized.
llogiq
force-pushed
the
cloned-side-effect-doc
branch
2 times, most recently
from
5e9b487
to
d3227fd
Compare
This comment has been minimized.
This comment has been minimized.
llogiq
force-pushed
the
cloned-side-effect-doc
branch
from
d3227fd
to
516112a
Compare
the8472
reviewed
Jan 18, 2022
| /// // instead call `cloned` late: | ||
| /// let good: Vec<_> = a.iter().filter(|s| s.len() == 1).cloned().collect(); | ||
| /// assert_eq!(&[".".to_string()], &good[..]); | ||
| /// ``` |
There was a problem hiding this comment.
I think this part should be fairly uncontroversial (modulo readability nits), it simply adds an implementation hint.
| /// There is no guarantee whatsoever about the `clone` method actually | ||
| /// being called *or* optimized away. So code should not depend on | ||
| /// either. | ||
| /// |
There was a problem hiding this comment.
This one seems a little more troublesome to me. I don't think this adds anything new, it simply makes the "no guarantee in either direction" which was previously implicit in the absence of detailed specification explicit. But some libs team members interpret API contracts differently than I do, so I want some extra eyes on this. Wait, I'm not assigned reviewer, nevermind 😅
There was a problem hiding this comment.
At least making it explicit allows us to point the user to the docs when they bemoan their code breaking should we ever decide to improve perf on this.
There was a problem hiding this comment.
I don't mind making the lack of a guarantee explicit, I don't believe this restricts us in any way which is the main thing I worry about with docs changes
the8472
added
the
T-libs-api
llogiq
force-pushed
the
cloned-side-effect-doc
branch
from
516112a
to
35a6f3b
Compare
JohnCSimon
added
S-waiting-on-author
JohnCSimon
added
S-waiting-on-author
Dylan-DPC
added
S-waiting-on-review
|
@yaahc this is waiting for review |
yaahc
reviewed
Mar 21, 2022
llogiq
force-pushed
the
cloned-side-effect-doc
branch
from
35a6f3b
to
1fb43f6
Compare
|
@bors r+ rollup=always |
|
📌 Commit 1fb43f6 has been approved by |
bors
added
S-waiting-on-bors
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Mar 23, 2022
Rollup of 6 pull requests Successful merges: - rust-lang#91608 (Fold aarch64 feature +fp into +neon) - rust-lang#92955 (add perf side effect docs to `Iterator::cloned()`) - rust-lang#94713 (Add u16::is_utf16_surrogate) - rust-lang#95212 (Replace `this.clone()` with `this.create_snapshot_for_diagnostic()`) - rust-lang#95219 (Modernize `alloc-no-oom-handling` test) - rust-lang#95222 (interpret/validity: improve clarity) Failed merges: r? `@ghost` `@rustbot` modify labels: rollup
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.
Now that #90209 has been closed, as the current state of affairs is neither here nor there, this at least adds a paragraph + example on what to expect performance-wise and how to deal with it to the .cloned() docs.
cc @the8472