Document some alternatives to Vec::split_off
#120180
Merged
Conversation
This file contains hidden or 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
|
(rustbot has picked a reviewer for you, use r? to override) |
rustbot
added
S-waiting-on-review
|
@bors r+ rollup |
bors
added
S-waiting-on-bors
matthiaskrgr
added a commit
to matthiaskrgr/rust
that referenced
this pull request
Jan 21, 2024
…s, r=dtolnay Document some alternatives to `Vec::split_off` One of the discussion points that came up in rust-lang#119917 is that some people use `Vec::split_off` in cases where they probably shouldn't, because the alternatives (like `mem::take`) are hard to discover. This PR adds some suggestions to the documentation of `split_off` that should point people towards alternatives that might be more appropriate for their use-case. I've deliberately tried to keep these changes as simple and uncontroversial as possible, so that they don't depend on how the team decides to handle the concerns raised in rust-lang#119917. That's why I haven't touched the existing documentation for `split_off`, and haven't added links to `split_off` to the documentation of other methods.
This was referenced Jan 21, 2024
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Jan 21, 2024
…iaskrgr Rollup of 8 pull requests Successful merges: - rust-lang#120005 (Update Readme) - rust-lang#120045 (Un-hide `iter::repeat_n`) - rust-lang#120128 (Make stable_mir::with_tables sound) - rust-lang#120145 (fix: Drop guard was deallocating with the incorrect size) - rust-lang#120158 (`rustc_mir_dataflow`: Restore removed exports) - rust-lang#120167 (Capture the rationale for `-Zallow-features=` in bootstrap.py) - rust-lang#120174 (Warn users about limited review for tier 2 and 3 code) - rust-lang#120180 (Document some alternatives to `Vec::split_off`) Failed merges: - rust-lang#120171 (Fix assume and assert in jump threading) r? `@ghost` `@rustbot` modify labels: rollup
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Jan 21, 2024
…iaskrgr Rollup of 8 pull requests Successful merges: - rust-lang#120005 (Update Readme) - rust-lang#120045 (Un-hide `iter::repeat_n`) - rust-lang#120128 (Make stable_mir::with_tables sound) - rust-lang#120145 (fix: Drop guard was deallocating with the incorrect size) - rust-lang#120158 (`rustc_mir_dataflow`: Restore removed exports) - rust-lang#120167 (Capture the rationale for `-Zallow-features=` in bootstrap.py) - rust-lang#120174 (Warn users about limited review for tier 2 and 3 code) - rust-lang#120180 (Document some alternatives to `Vec::split_off`) Failed merges: - rust-lang#120171 (Fix assume and assert in jump threading) r? `@ghost` `@rustbot` modify labels: rollup
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Jan 21, 2024
…iaskrgr Rollup of 8 pull requests Successful merges: - rust-lang#120005 (Update Readme) - rust-lang#120045 (Un-hide `iter::repeat_n`) - rust-lang#120128 (Make stable_mir::with_tables sound) - rust-lang#120145 (fix: Drop guard was deallocating with the incorrect size) - rust-lang#120158 (`rustc_mir_dataflow`: Restore removed exports) - rust-lang#120167 (Capture the rationale for `-Zallow-features=` in bootstrap.py) - rust-lang#120174 (Warn users about limited review for tier 2 and 3 code) - rust-lang#120180 (Document some alternatives to `Vec::split_off`) Failed merges: - rust-lang#120171 (Fix assume and assert in jump threading) r? `@ghost` `@rustbot` modify labels: rollup
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Jan 21, 2024
…iaskrgr Rollup of 8 pull requests Successful merges: - rust-lang#120005 (Update Readme) - rust-lang#120045 (Un-hide `iter::repeat_n`) - rust-lang#120128 (Make stable_mir::with_tables sound) - rust-lang#120145 (fix: Drop guard was deallocating with the incorrect size) - rust-lang#120158 (`rustc_mir_dataflow`: Restore removed exports) - rust-lang#120167 (Capture the rationale for `-Zallow-features=` in bootstrap.py) - rust-lang#120174 (Warn users about limited review for tier 2 and 3 code) - rust-lang#120180 (Document some alternatives to `Vec::split_off`) Failed merges: - rust-lang#120171 (Fix assume and assert in jump threading) r? `@ghost` `@rustbot` modify labels: rollup
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Jan 22, 2024
…iaskrgr Rollup of 8 pull requests Successful merges: - rust-lang#120005 (Update Readme) - rust-lang#120045 (Un-hide `iter::repeat_n`) - rust-lang#120128 (Make stable_mir::with_tables sound) - rust-lang#120145 (fix: Drop guard was deallocating with the incorrect size) - rust-lang#120158 (`rustc_mir_dataflow`: Restore removed exports) - rust-lang#120167 (Capture the rationale for `-Zallow-features=` in bootstrap.py) - rust-lang#120174 (Warn users about limited review for tier 2 and 3 code) - rust-lang#120180 (Document some alternatives to `Vec::split_off`) Failed merges: - rust-lang#120171 (Fix assume and assert in jump threading) r? `@ghost` `@rustbot` modify labels: rollup
rust-timer
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Jan 22, 2024
Rollup merge of rust-lang#120180 - Zalathar:vec-split-off-alternatives, r=dtolnay Document some alternatives to `Vec::split_off` One of the discussion points that came up in rust-lang#119917 is that some people use `Vec::split_off` in cases where they probably shouldn't, because the alternatives (like `mem::take`) are hard to discover. This PR adds some suggestions to the documentation of `split_off` that should point people towards alternatives that might be more appropriate for their use-case. I've deliberately tried to keep these changes as simple and uncontroversial as possible, so that they don't depend on how the team decides to handle the concerns raised in rust-lang#119917. That's why I haven't touched the existing documentation for `split_off`, and haven't added links to `split_off` to the documentation of other methods.
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.
One of the discussion points that came up in #119917 is that some people use
Vec::split_offin cases where they probably shouldn't, because the alternatives (likemem::take) are hard to discover.This PR adds some suggestions to the documentation of
split_offthat should point people towards alternatives that might be more appropriate for their use-case.I've deliberately tried to keep these changes as simple and uncontroversial as possible, so that they don't depend on how the team decides to handle the concerns raised in #119917. That's why I haven't touched the existing documentation for
split_off, and haven't added links tosplit_offto the documentation of other methods.