docs: Mention spare_capacity_mut() in Vec::set_len
#126118
Conversation
|
Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @m-ou-se (or someone else) some time within the next two weeks. Please see the contribution instructions for more information. Namely, in order to ensure the minimum review times lag, PR authors and assigned reviewers should ensure that the review label (
|
rustbot
added
S-waiting-on-review
This comment has been minimized.
This comment has been minimized.
library/alloc/src/vec/mod.rs
Outdated
| /// unsafe { | ||
| /// vec.set_len(256); | ||
| /// } | ||
| /// ``` |
There was a problem hiding this comment.
It might even be worth it to move this above the FFI example since this use usable with pure rust.
There was a problem hiding this comment.
Happy to amend the commit accordingly. Who'd be an authority for such decisions?
There was a problem hiding this comment.
Who'd be an authority for such decisions?
Whoever says something that makes the most sense, which could be you :) docs changes are usually EAFP. (agreed that it makes sense to move this up).
library/alloc/src/vec/mod.rs
Outdated
| /// unsafe { | ||
| /// vec.set_len(256); | ||
| /// } |
There was a problem hiding this comment.
Minor style:
| /// unsafe { | |
| /// vec.set_len(256); | |
| /// } | |
| /// unsafe { vec.set_len(256) }; |
There was a problem hiding this comment.
Though I'd also write it like you suggest, I've based this on the existing examples for the same method and opted for consistency.
|
Maybe it's best to just link to the documentation+example of spare_capacity_mut? Or to re-use the example from that method's documentation? |
|
I feel queasy about copy-pasting the example from |
|
@bors r+ |
bors
added
S-waiting-on-bors
I recently went down a small rabbit hole when trying to identify safe use of
Vec::set_len. The solution wasVec::spare_capacity_mut. I think the docs onVec::set_lenbenefit from mentioning this method.A possible counter-argument could be that the clippy lint
uninit_vecalready nudges people in the right direction. However, I think a working example onVec::set_lenis still beneficial.Happy to hear your thoughts on the matter. 😊