diff options
| author | Guillaume Gomez <guillaume1.gomez@gmail.com> | 2016-08-02 03:28:13 +0200 |
|---|---|---|
| committer | Guillaume Gomez <guillaume1.gomez@gmail.com> | 2016-08-02 20:45:31 +0200 |
| commit | 1fa9b8dc96f95ec5d6c95746d58e96f507ab85fd (patch) | |
| tree | d59aa840e6f11c7562504f76f96d7eff6aa8bbdd | |
| parent | 34d14e7eed48c755a660224266e2c86669cf5483 (diff) | |
| download | rust-1fa9b8dc96f95ec5d6c95746d58e96f507ab85fd.tar.gz rust-1fa9b8dc96f95ec5d6c95746d58e96f507ab85fd.zip | |
Add doc example for Vec
| -rw-r--r-- | src/libcollections/vec.rs | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/src/libcollections/vec.rs b/src/libcollections/vec.rs index 275f38b2f78..8b4fce158de 100644 --- a/src/libcollections/vec.rs +++ b/src/libcollections/vec.rs @@ -476,6 +476,25 @@ impl<T> Vec<T> { /// Note that this will drop any excess capacity. Calling this and /// converting back to a vector with `into_vec()` is equivalent to calling /// `shrink_to_fit()`. + /// + /// # Examples + /// + /// ``` + /// let v = vec![1, 2, 3]; + /// + /// let slice = v.into_boxed_slice(); + /// ``` + /// + /// Any excess capacity is removed: + /// + /// ``` + /// let mut vec = Vec::with_capacity(10); + /// vec.extend([1, 2, 3].iter().cloned()); + /// + /// assert_eq!(vec.capacity(), 10); + /// let slice = vec.into_boxed_slice(); + /// assert_eq!(slice.into_vec().capacity(), 3); + /// ``` #[stable(feature = "rust1", since = "1.0.0")] pub fn into_boxed_slice(mut self) -> Box<[T]> { unsafe { |
