Vec::splice() should explain what happens with an empty range
#135369
Assignees
Labels
A-collections
Area: `std::collections`
A-docs
Area: Documentation for any part of the project, including the compiler, standard library, and tools
T-libs
Relevant to the library team, which will review and decide on the PR/issue.
Comments
djeedai
added
the
A-docs
rustbot
added
the
needs-triage
fmease
added
the
T-libs
Noratrieb
removed
the
needs-triage
|
I added an example to the |
|
Yes, documentation changes that do not introduce new API guarantees don't require more than a PR. |
rust-timer
added a commit
to rust-lang-ci/rust
that referenced
this issue
Jan 14, 2025
Rollup merge of rust-lang#135381 - cod10129:vec-splice-doc, r=tgross35 Add an example for `Vec::splice` inserting elements without removing This example clearly showcases how `splice` can be used to insert multiple elements efficiently at an index into a vector. Fixes rust-lang#135369. The added example: > Using `splice` to insert new items into a vector efficiently at a specific position indicated by an empty range: > ```rust > let mut v = vec![1, 5]; > let new = [2, 3, 4]; > v.splice(1..1, new); > assert_eq!(v, [1, 2, 3, 4, 5]); > ``` `@rustbot` label A-docs A-collections
github-actions bot
pushed a commit
to tautschnig/verify-rust-std
that referenced
this issue
Mar 11, 2025
Add an example for `Vec::splice` inserting elements without removing This example clearly showcases how `splice` can be used to insert multiple elements efficiently at an index into a vector. Fixes rust-lang#135369. The added example: > Using `splice` to insert new items into a vector efficiently at a specific position indicated by an empty range: > ```rust > let mut v = vec![1, 5]; > let new = [2, 3, 4]; > v.splice(1..1, new); > assert_eq!(v, [1, 2, 3, 4, 5]); > ``` `@rustbot` label A-docs A-collections
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Location
https://doc.rust-lang.org/std/vec/struct.Vec.html#method.splice
Summary
As explained in this SO answer, which I assume to be correct, using
Vec::splice()with an empty range like3..3and a non-emptyreplace_withargument allows inserting multiple values at once at the index specified by, I think, the range start. But this is not documented, and I don't think it's necessarily trivial for everyone (I had to lookup that SO answer to confirm). I think an example of inserting multiple values without removing any would be beneficial for understanding thatsplice()is the right tool for that job (and you don't need anything more complicated via iterators and loops or whatnot, like others on SO suggested).The text was updated successfully, but these errors were encountered: