tests + docs

Author: conradludgate

src/arrayvec.rs

@@ -640,12 +640,25 @@ impl<T, const CAP: usize> ArrayVec<T, CAP> {
         }
     }
 
+    /// Return the inner fixed size array.
+    ///
+    /// Safety:
+    /// This operation is safe if and only if length equals capacity.
     pub unsafe fn into_inner_unchecked(self) -> [T; CAP] {
         let self_ = ManuallyDrop::new(self);
         let array = ptr::read(self_.as_ptr() as *const [T; CAP]);
         array
     }
 
+    /// Returns the ArrayVec, replacing the original with a new empty ArrayVec.
+    ///
+    /// ```
+    /// use arrayvec::ArrayVec;
+    ///
+    /// let mut v = ArrayVec::from([0, 1, 2, 3]);
+    /// assert_eq!([0, 1, 2, 3], v.take().into_inner().unwrap());
+    /// assert!(v.is_empty());
+    /// ```
     pub fn take(&mut self) -> Self  {
         mem::replace(self, Self::new())
     }

tests/tests.rs

@@ -153,6 +153,21 @@ fn test_drop() {
         assert_eq!(flag.get(), 3);
     }
 
+    // test take
+    flag.set(0);
+    {
+        let mut array1 = ArrayVec::<_,  3>::new();
+        array1.push(Bump(flag));
+        array1.push(Bump(flag));
+        array1.push(Bump(flag));
+        let array2 = array1.take();
+        assert_eq!(flag.get(), 0);
+        drop(array1);
+        assert_eq!(flag.get(), 0);
+        drop(array2);
+        assert_eq!(flag.get(), 3);
+    }
+
     // test cloning into_iter
     flag.set(0);
     {
@@ -461,6 +476,15 @@ fn test_into_inner_3() {
     assert_eq!(v.into_inner().unwrap(), [1, 2, 3, 4]);
 }
 
+#[test]
+fn test_take() {
+    let mut v1 = ArrayVec::<i32,  4>::new();
+    v1.extend(1..=4);
+    let v2 = v1.take();
+    assert!(v1.into_inner().is_err());
+    assert_eq!(v2.into_inner().unwrap(), [1, 2, 3, 4]);
+}
+
 #[cfg(feature="std")]
 #[test]
 fn test_write() {