Skip to content

Commit 1d678a5

Browse files
authoredJan 21, 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.
2 parents bbbadb1 + 6f1944d commit 1d678a5

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed
 

Diff for: ‎library/alloc/src/vec/mod.rs

+6
Original file line numberDiff line numberDiff line change
@@ -2167,6 +2167,12 @@ impl<T, A: Allocator> Vec<T, A> {
21672167
/// `[at, len)`. After the call, the original vector will be left containing
21682168
/// the elements `[0, at)` with its previous capacity unchanged.
21692169
///
2170+
/// - If you want to take ownership of the entire contents and capacity of
2171+
/// the vector, see [`mem::take`] or [`mem::replace`].
2172+
/// - If you don't need the returned vector at all, see [`Vec::truncate`].
2173+
/// - If you want to take ownership of an arbitrary subslice, or you don't
2174+
/// necessarily want to store the removed items in a vector, see [`Vec::drain`].
2175+
///
21702176
/// # Panics
21712177
///
21722178
/// Panics if `at > len`.

0 commit comments

Comments
 (0)