changelog: Add manual_as_slice lint

Author: nils-degroot

CHANGELOG.md

@@ -5943,6 +5943,7 @@ Released 2018-09-13
 [`macro_use_imports`]: https://rust-lang.github.io/rust-clippy/master/index.html#macro_use_imports
 [`main_recursion`]: https://rust-lang.github.io/rust-clippy/master/index.html#main_recursion
 [`manual_abs_diff`]: https://rust-lang.github.io/rust-clippy/master/index.html#manual_abs_diff
+[`manual_as_slice`]: https://rust-lang.github.io/rust-clippy/master/index.html#manual_as_slice
 [`manual_assert`]: https://rust-lang.github.io/rust-clippy/master/index.html#manual_assert
 [`manual_async_fn`]: https://rust-lang.github.io/rust-clippy/master/index.html#manual_async_fn
 [`manual_bits`]: https://rust-lang.github.io/rust-clippy/master/index.html#manual_bits

clippy_lints/src/declared_lints.rs

@@ -288,6 +288,7 @@ pub static LINTS: &[&crate::LintInfo] = &[
     crate::macro_use::MACRO_USE_IMPORTS_INFO,
     crate::main_recursion::MAIN_RECURSION_INFO,
     crate::manual_abs_diff::MANUAL_ABS_DIFF_INFO,
+    crate::manual_as_slice::MANUAL_AS_SLICE_INFO,
     crate::manual_assert::MANUAL_ASSERT_INFO,
     crate::manual_async_fn::MANUAL_ASYNC_FN_INFO,
     crate::manual_bits::MANUAL_BITS_INFO,

clippy_lints/src/lib.rs

@@ -204,6 +204,7 @@ mod macro_metavars_in_unsafe;
 mod macro_use;
 mod main_recursion;
 mod manual_abs_diff;
+mod manual_as_slice;
 mod manual_assert;
 mod manual_async_fn;
 mod manual_bits;
@@ -944,5 +945,6 @@ pub fn register_lints(store: &mut rustc_lint::LintStore, conf: &'static Conf) {
     store.register_late_pass(|_| Box::new(single_option_map::SingleOptionMap));
     store.register_late_pass(move |_| Box::new(redundant_test_prefix::RedundantTestPrefix));
     store.register_late_pass(|_| Box::new(cloned_ref_to_slice_refs::ClonedRefToSliceRefs::new(conf)));
+    store.register_late_pass(|_| Box::new(manual_as_slice::ManualAsSlice));
     // add lints here, do not remove this comment, it's used in `new_lint`
 }

clippy_lints/src/manual_as_slice.rs

@@ -0,0 +1,59 @@
+use clippy_utils::diagnostics::span_lint_and_sugg;
+use clippy_utils::source::snippet_with_applicability;
+use rustc_errors::Applicability;
+use rustc_hir::{Expr, ExprKind, LangItem, Mutability, QPath};
+use rustc_lint::{LateContext, LateLintPass};
+use rustc_session::declare_lint_pass;
+
+declare_clippy_lint! {
+    /// ### What it does
+    ///
+    /// Detects if a full range slice reference is used instead of using the `.as_slice()` method.
+    ///
+    /// ### Why is this bad?
+    ///
+    /// Using the `some_value.as_slice()` method is more explicit then using `&some_value[..]`
+    ///
+    /// ### Example
+    /// ```no_run
+    /// let array: [u8; 4] = [0; 4];
+    /// let slice = &array[..];
+    /// ```
+    /// Use instead:
+    /// ```no_run
+    /// let array: [u8; 4] = [0; 4];
+    /// let slice = array.as_slice();
+    /// ```
+    #[clippy::version = "1.88.0"]
+    pub MANUAL_AS_SLICE,
+    nursery,
+    "Use as slice instead of borrow full range."
+}
+declare_lint_pass!(ManualAsSlice => [MANUAL_AS_SLICE]);
+
+impl LateLintPass<'_> for ManualAsSlice {
+    fn check_expr(&mut self, cx: &LateContext<'_>, expr: &Expr<'_>) {
+        if let ExprKind::AddrOf(_, mutability, borrow) = expr.kind
+            && let ExprKind::Index(name, indexing, _) = borrow.kind
+            && !name.span.from_expansion()
+            && let ExprKind::Struct(qpath, _, _) = indexing.kind
+            && let QPath::LangItem(LangItem::RangeFull, _) = qpath
+        {
+            let mut app = Applicability::MachineApplicable;
+            let snippet = snippet_with_applicability(cx, name.span, "..", &mut app);
+
+            let (msg, sugg) = match mutability {
+                Mutability::Not => (
+                    "use `.as_slice()` instead of full range slice",
+                    format!("{snippet}.as_slice()"),
+                ),
+                Mutability::Mut => (
+                    "use `.as_mut_slice()` instead of full range slice",
+                    format!("{snippet}.as_mut_slice()"),
+                ),
+            };
+
+            span_lint_and_sugg(cx, MANUAL_AS_SLICE, expr.span, msg, "try", sugg, app);
+        }
+    }
+}

tests/ui/manual_as_slice.fixed

@@ -0,0 +1,39 @@
+#![warn(clippy::manual_as_slice)]
+
+mod nested_1 {
+    pub(crate) mod nested_2 {
+        pub(crate) const SOME_VALUE: [u8; 4] = [1, 2, 3, 4];
+    }
+}
+
+fn main() {
+    let array: [u8; 4] = [0; 4];
+    let slice: &[u8] = array.as_slice();
+    //~^ manual_as_slice
+
+    let mut array: [u8; 4] = [0; 4];
+    let mut slice: &[u8] = array.as_mut_slice();
+    //~^ manual_as_slice
+
+    let slice: &[u8] = nested_1::nested_2::SOME_VALUE.as_slice();
+    //~^ manual_as_slice
+
+    let slice = b"foo";
+    let slice: &[u8] = slice.as_slice();
+    //~^ manual_as_slice
+
+    let slice = &[1, 2, 3, 4];
+    let slice: &[u8] = slice.as_slice();
+    //~^ manual_as_slice
+
+    let slice: &[u8] = &vec![1, 2, 3][..];
+
+    macro_rules! perform_the_slice {
+        ($a:expr) => {
+            [1, 2, 3].as_slice()
+            //~^ manual_as_slice
+        };
+    }
+
+    perform_the_slice!([1, 2, 3]);
+}

tests/ui/manual_as_slice.rs

@@ -0,0 +1,37 @@
+#![warn(clippy::manual_as_slice)]
+
+mod nested_1 {
+    pub(crate) mod nested_2 {
+        pub(crate) const SOME_VALUE: [u8; 4] = [1, 2, 3, 4];
+    }
+}
+
+fn main() {
+    let array: [u8; 4] = [0; 4];
+    let slice: &[u8] = &array[..];
+    //~^ manual_as_slice
+
+    let mut array: [u8; 4] = [0; 4];
+    let mut slice: &[u8] = &mut array[..];
+    //~^ manual_as_slice
+
+    let slice: &[u8] = &nested_1::nested_2::SOME_VALUE[..];
+    //~^ manual_as_slice
+
+    let slice = b"foo";
+    let slice: &[u8] = &slice[..];
+    //~^ manual_as_slice
+
+    let slice = &[1, 2, 3, 4];
+    let slice: &[u8] = &slice[..];
+    //~^ manual_as_slice
+
+    macro_rules! perform_the_slice {
+        ($a:expr) => {
+            &$a[..]
+            //~^ manual_as_slice
+        };
+    }
+
+    perform_the_slice!([1, 2, 3]);
+}

tests/ui/manual_as_slice.stderr

@@ -0,0 +1,46 @@
+error: use `.as_slice()` instead of full range slice
+  --> tests/ui/manual_as_slice.rs:11:24
+   |
+LL |     let slice: &[u8] = &array[..];
+   |                        ^^^^^^^^^^ help: try: `array.as_slice()`
+   |
+   = note: `-D clippy::manual-as-slice` implied by `-D warnings`
+   = help: to override `-D warnings` add `#[allow(clippy::manual_as_slice)]`
+
+error: use `.as_mut_slice()` instead of full range slice
+  --> tests/ui/manual_as_slice.rs:15:28
+   |
+LL |     let mut slice: &[u8] = &mut array[..];
+   |                            ^^^^^^^^^^^^^^ help: try: `array.as_mut_slice()`
+
+error: use `.as_slice()` instead of full range slice
+  --> tests/ui/manual_as_slice.rs:18:24
+   |
+LL |     let slice: &[u8] = &nested_1::nested_2::SOME_VALUE[..];
+   |                        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: try: `nested_1::nested_2::SOME_VALUE.as_slice()`
+
+error: use `.as_slice()` instead of full range slice
+  --> tests/ui/manual_as_slice.rs:22:24
+   |
+LL |     let slice: &[u8] = &slice[..];
+   |                        ^^^^^^^^^^ help: try: `slice.as_slice()`
+
+error: use `.as_slice()` instead of full range slice
+  --> tests/ui/manual_as_slice.rs:26:24
+   |
+LL |     let slice: &[u8] = &slice[..];
+   |                        ^^^^^^^^^^ help: try: `slice.as_slice()`
+
+error: use `.as_slice()` instead of full range slice
+  --> tests/ui/manual_as_slice.rs:33:13
+   |
+LL |             &$a[..]
+   |             ^^^^^^^ help: try: `[1, 2, 3].as_slice()`
+...
+LL |     perform_the_slice!([1, 2, 3]);
+   |     ----------------------------- in this macro invocation
+   |
+   = note: this error originates in the macro `perform_the_slice` (in Nightly builds, run with -Z macro-backtrace for more info)
+
+error: aborting due to 6 previous errors
+