Deprecate from_slice methods

Deprecates the following in favor of `TryFrom`: - `Array::clone_from_slice` - `Array::from_slice` - `Array::from_mut_slice` Notably these methods panic instead of making it possible to handle length mismatch errors.
RustCrypto · Mar 17, 2024 · a3c8280 · a3c8280
1 parent aeedcbf
commit a3c8280
Show file tree

Hide file tree

Showing 2 changed files with 49 additions and 54 deletions.
diff --git a/src/lib.rs b/src/lib.rs
@@ -185,45 +185,6 @@ where
         self.0.as_mut()
     }
 
-    /// Convert the given slice into a reference to a hybrid array.
-    ///
-    /// # Panics
-    ///
-    /// Panics if the slice's length doesn't match the array type.
-    // TODO(tarcieri): deprecate this before the v0.2 release
-    // #[deprecated(since = "0.2.0", note = "use TryFrom instead")]
-    #[inline]
-    pub fn from_slice(slice: &[T]) -> &Self {
-        slice.try_into().expect("slice length mismatch")
-    }
-
-    /// Convert the given mutable slice to a mutable reference to a hybrid array.
-    ///
-    /// # Panics
-    ///
-    /// Panics if the slice's length doesn't match the array type.
-    // TODO(tarcieri): deprecate this before the v0.2 release
-    // #[deprecated(since = "0.2.0", note = "use TryFrom instead")]
-    #[inline]
-    pub fn from_mut_slice(slice: &mut [T]) -> &mut Self {
-        slice.try_into().expect("slice length mismatch")
-    }
-
-    /// Clone the contents of the slice as a new hybrid array.
-    ///
-    /// # Panics
-    ///
-    /// Panics if the slice's length doesn't match the array type.
-    // TODO(tarcieri): deprecate this before the v0.2 release
-    // #[deprecated(since = "0.2.0", note = "use TryFrom instead")]
-    #[inline]
-    pub fn clone_from_slice(slice: &[T]) -> Self
-    where
-        Self: Clone,
-    {
-        slice.try_into().expect("slice length mismatch")
-    }
-
     /// Returns an iterator over the array.
     #[inline]
     pub fn iter(&self) -> Iter<'_, T> {
@@ -351,6 +312,42 @@ where
             (chunks, tail)
         }
     }
+
+    /// Convert the given slice into a reference to a hybrid array.
+    ///
+    /// # Panics
+    ///
+    /// Panics if the slice's length doesn't match the array type.
+    #[deprecated(since = "0.2.0", note = "use `TryFrom` instead")]
+    #[inline]
+    pub fn from_slice(slice: &[T]) -> &Self {
+        slice.try_into().expect("slice length mismatch")
+    }
+
+    /// Convert the given mutable slice to a mutable reference to a hybrid array.
+    ///
+    /// # Panics
+    ///
+    /// Panics if the slice's length doesn't match the array type.
+    #[deprecated(since = "0.2.0", note = "use `TryFrom` instead")]
+    #[inline]
+    pub fn from_mut_slice(slice: &mut [T]) -> &mut Self {
+        slice.try_into().expect("slice length mismatch")
+    }
+
+    /// Clone the contents of the slice as a new hybrid array.
+    ///
+    /// # Panics
+    ///
+    /// Panics if the slice's length doesn't match the array type.
+    #[deprecated(since = "0.2.0", note = "use `TryFrom` instead")]
+    #[inline]
+    pub fn clone_from_slice(slice: &[T]) -> Self
+    where
+        Self: Clone,
+    {
+        slice.try_into().expect("slice length mismatch")
+    }
 }
 
 // Impls which depend on the inner array type being `[T; N]`.

diff --git a/tests/mod.rs b/tests/mod.rs
@@ -7,12 +7,6 @@ const EXAMPLE_SLICE: &[u8] = &[1, 2, 3, 4, 5, 6];
 /// Ensure `ArrayN` works as expected.
 const _FOO: ArrayN<u8, 4> = Array([1, 2, 3, 4]);
 
-#[test]
-fn clone_from_slice() {
-    let array = Array::<u8, U6>::clone_from_slice(EXAMPLE_SLICE);
-    assert_eq!(array.as_slice(), EXAMPLE_SLICE);
-}
-
 #[test]
 fn tryfrom_slice_for_array() {
     assert!(Array::<u8, U0>::try_from(EXAMPLE_SLICE).is_err());
@@ -37,17 +31,16 @@ fn tryfrom_slice_for_array_ref() {
 
 #[test]
 fn concat() {
-    let prefix = Array::<u8, U2>::clone_from_slice(&EXAMPLE_SLICE[..2]);
-    let suffix = Array::<u8, U4>::clone_from_slice(&EXAMPLE_SLICE[2..]);
+    let prefix = Array::<u8, U2>::try_from(&EXAMPLE_SLICE[..2]).unwrap();
+    let suffix = Array::<u8, U4>::try_from(&EXAMPLE_SLICE[2..]).unwrap();
 
     let array = prefix.concat(suffix);
     assert_eq!(array.as_slice(), EXAMPLE_SLICE);
 }
 
 #[test]
 fn split() {
-    let array = Array::<u8, U6>::clone_from_slice(EXAMPLE_SLICE);
-
+    let array = Array::<u8, U6>::try_from(EXAMPLE_SLICE).unwrap();
     let (prefix, suffix) = array.split::<U2>();
 
     assert_eq!(prefix.as_slice(), &EXAMPLE_SLICE[..2]);
@@ -56,8 +49,7 @@ fn split() {
 
 #[test]
 fn split_ref() {
-    let array = Array::<u8, U6>::clone_from_slice(EXAMPLE_SLICE);
-
+    let array = Array::<u8, U6>::try_from(EXAMPLE_SLICE).unwrap();
     let (prefix, suffix) = array.split_ref::<U3>();
 
     assert_eq!(prefix.as_slice(), &EXAMPLE_SLICE[..3]);
@@ -66,8 +58,7 @@ fn split_ref() {
 
 #[test]
 fn split_ref_mut() {
-    let array = &mut Array::<u8, U6>::clone_from_slice(EXAMPLE_SLICE);
-
+    let array = &mut Array::<u8, U6>::try_from(EXAMPLE_SLICE).unwrap();
     let (prefix, suffix) = array.split_ref_mut::<U4>();
 
     assert_eq!(prefix.as_slice(), &EXAMPLE_SLICE[..4]);
@@ -141,8 +132,15 @@ fn maybe_uninit() {
 }
 
 #[test]
-fn test_map() {
+fn map() {
     let base = Array::<u8, U4>::from([1, 2, 3, 4]);
     let expected = Array::<u16, U4>::from([2, 3, 4, 5]);
     assert_eq!(base.map(|item| (item as u16) + 1), expected);
 }
+
+#[test]
+#[allow(deprecated)]
+fn clone_from_slice() {
+    let array = Array::<u8, U6>::clone_from_slice(EXAMPLE_SLICE);
+    assert_eq!(array.as_slice(), EXAMPLE_SLICE);
+}