explain safety for vec.set_len(0)

RalfJung · Jan 9, 2019 · 5052197 · 5052197
1 parent 61fb909
commit 5052197
Showing 1 changed file with 3 additions and 0 deletions.
diff --git 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);
     /// }