Add notes about capacity effects to Vec::truncate() #39738
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
|
r? @brson (rust_highfive has picked a reviewer for you, use r? to override) |
|
Is this an implementation detail or something we want to guarantee? |
frewsxcv
added
T-libs-api
brson
reviewed
Feb 13, 2017
src/libcollections/vec.rs
Outdated
| @@ -545,6 +545,9 @@ impl<T> Vec<T> { | |||
| /// The [`drain`] method can emulate `truncate`, but causes the excess | |||
| /// elements to be returned instead of dropped. | |||
| /// | |||
| /// Note that his method has no effect on the allocated capacity | |||
| /// of the vector. | |||
| /// | |||
BurntSushi
reviewed
Feb 13, 2017
src/libcollections/vec.rs
Outdated
| @@ -1089,6 +1092,9 @@ impl<T> Vec<T> { | |||
|
|
|||
| /// Clears the vector, removing all values. | |||
| /// | |||
| /// Note that this method has no effect on the allocated capacity | |||
| /// of the vector, and is equivalent to calling `truncate(0)`. | |||
There was a problem hiding this comment.
Could this comment be a little less specific about the implementation? As it stands, the implementation is in the comment itself. (I am being a little paranoid here.)
|
Could you also update the similar methods on |
keeperofdakeys
force-pushed
the
vec-docs
branch
from
0d00bd6 to
4be5783
Compare
|
@brson Are there any outstanding issues here? |
|
Sounds good to me. Thanks a lot for this add! @bors: r+ rollup |
|
📌 Commit 4be5783 has been approved by |
bors
added a commit
that referenced
this pull request
Feb 26, 2017
Add notes about capacity effects to Vec::truncate() Add notes about the effects of Vec::truncate() and Vec::clear() on the capacity of a vector.
|
☀️ Test successful - status-appveyor, status-travis |
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.
Add notes about the effects of Vec::truncate() and Vec::clear() on the capacity of a vector.