about summary refs log tree commit diff
diff options
context:
space:
mode:
authorscottmcm <scottmcm@users.noreply.github.com>2019-01-08 19:41:32 -0800
committerGitHub <noreply@github.com>2019-01-08 19:41:32 -0800
commit986e49da04fbe2543267561eb8326765c9f48195 (patch)
treecbbc587d9462341f59e2aaafe48f667eb8797a0a
parent61fb909559bc61e2179f3ea7b62b60e2e7df3ac0 (diff)
parent5052197e447a2279a63e8ef06179ca01b657eb9b (diff)
downloadrust-986e49da04fbe2543267561eb8326765c9f48195.tar.gz
rust-986e49da04fbe2543267561eb8326765c9f48195.zip
Merge pull request #1 from Centril/redo-vec-set_len-docs-adjust
Explain safety for `vec.set_len(0)`
-rw-r--r--src/liballoc/vec.rs3
1 files changed, 3 insertions, 0 deletions
diff --git a/src/liballoc/vec.rs b/src/liballoc/vec.rs
index 30bcc034221..0da00b70f9e 100644
--- a/src/liballoc/vec.rs
+++ b/src/liballoc/vec.rs
@@ -816,6 +816,9 @@ impl<T> Vec<T> {
     /// let mut vec = vec![vec![1, 0, 0],
     ///                    vec![0, 1, 0],
     ///                    vec![0, 0, 1]];
+    /// // SAFETY:
+    /// // 1. `old_len..0` is empty so no elements need to be initialized.
+    /// // 2. `0 <= capacity` always holds whatever `capacity` is.
     /// unsafe {
     ///     vec.set_len(0);
     /// }