2 use crate::{EarlyContext, EarlyLintPass, LateContext, LateLintPass, LintContext};
4 use rustc_ast::util::{classify, parser};
5 use rustc_ast::{ExprKind, StmtKind};
6 use rustc_errors::{fluent, pluralize, Applicability, MultiSpan};
8 use rustc_hir::def::{DefKind, Res};
9 use rustc_hir::def_id::DefId;
10 use rustc_infer::traits::util::elaborate_predicates_with_span;
11 use rustc_middle::ty::adjustment;
12 use rustc_middle::ty::{self, DefIdTree, Ty};
13 use rustc_span::symbol::Symbol;
14 use rustc_span::symbol::{kw, sym};
15 use rustc_span::{BytePos, Span};
19 /// The `unused_must_use` lint detects unused result of a type flagged as
25 /// fn returns_result() -> Result<(), ()> {
38 /// The `#[must_use]` attribute is an indicator that it is a mistake to
39 /// ignore the value. See [the reference] for more details.
41 /// [the reference]: https://doc.rust-lang.org/reference/attributes/diagnostics.html#the-must_use-attribute
44 "unused result of a type flagged as `#[must_use]`",
45 report_in_external_macro
49 /// The `unused_results` lint checks for the unused result of an
50 /// expression in a statement.
54 /// ```rust,compile_fail
55 /// #![deny(unused_results)]
56 /// fn foo<T>() -> T { panic!() }
67 /// Ignoring the return value of a function may indicate a mistake. In
68 /// cases were it is almost certain that the result should be used, it is
69 /// recommended to annotate the function with the [`must_use` attribute].
70 /// Failure to use such a return value will trigger the [`unused_must_use`
71 /// lint] which is warn-by-default. The `unused_results` lint is
72 /// essentially the same, but triggers for *all* return values.
74 /// This lint is "allow" by default because it can be noisy, and may not be
75 /// an actual problem. For example, calling the `remove` method of a `Vec`
76 /// or `HashMap` returns the previous value, which you may not care about.
77 /// Using this lint would require explicitly ignoring or discarding such
80 /// [`must_use` attribute]: https://doc.rust-lang.org/reference/attributes/diagnostics.html#the-must_use-attribute
81 /// [`unused_must_use` lint]: warn-by-default.html#unused-must-use
84 "unused result of an expression in a statement"
87 declare_lint_pass!(UnusedResults => [UNUSED_MUST_USE, UNUSED_RESULTS]);
89 impl<'tcx> LateLintPass<'tcx> for UnusedResults {
90 fn check_stmt(&mut self, cx: &LateContext<'_>, s: &hir::Stmt<'_>) {
91 let hir::StmtKind::Semi(expr) = s.kind else { return; };
93 if let hir::ExprKind::Ret(..) = expr.kind {
97 if let hir::ExprKind::Match(await_expr, _arms, hir::MatchSource::AwaitDesugar) = expr.kind
98 && let ty = cx.typeck_results().expr_ty(&await_expr)
99 && let ty::Opaque(future_def_id, _) = ty.kind()
100 && cx.tcx.ty_is_opaque_future(ty)
101 // FIXME: This also includes non-async fns that return `impl Future`.
102 && let async_fn_def_id = cx.tcx.parent(*future_def_id)
103 && check_must_use_def(
107 "output of future returned by ",
111 // We have a bare `foo().await;` on an opaque type from an async function that was
112 // annotated with `#[must_use]`.
116 let ty = cx.typeck_results().expr_ty(&expr);
118 let must_use_result = is_ty_must_use(cx, ty, &expr, expr.span);
119 let type_lint_emitted_or_suppressed = match must_use_result {
121 emit_must_use_untranslated(cx, &path, "", "", 1);
127 let fn_warned = check_fn_must_use(cx, expr);
129 if !fn_warned && type_lint_emitted_or_suppressed {
130 // We don't warn about unused unit or uninhabited types.
131 // (See https://github.com/rust-lang/rust/issues/43806 for details.)
135 let must_use_op = match expr.kind {
136 // Hardcoding operators here seemed more expedient than the
137 // refactoring that would be needed to look up the `#[must_use]`
138 // attribute which does exist on the comparison trait methods
139 hir::ExprKind::Binary(bin_op, ..) => match bin_op.node {
145 | hir::BinOpKind::Gt => Some("comparison"),
147 | hir::BinOpKind::Sub
148 | hir::BinOpKind::Div
149 | hir::BinOpKind::Mul
150 | hir::BinOpKind::Rem => Some("arithmetic operation"),
151 hir::BinOpKind::And | hir::BinOpKind::Or => Some("logical operation"),
152 hir::BinOpKind::BitXor
153 | hir::BinOpKind::BitAnd
154 | hir::BinOpKind::BitOr
155 | hir::BinOpKind::Shl
156 | hir::BinOpKind::Shr => Some("bitwise operation"),
158 hir::ExprKind::AddrOf(..) => Some("borrow"),
159 hir::ExprKind::Unary(..) => Some("unary operation"),
163 let mut op_warned = false;
165 if let Some(must_use_op) = must_use_op {
166 cx.struct_span_lint(UNUSED_MUST_USE, expr.span, fluent::lint_unused_op, |lint| {
167 lint.set_arg("op", must_use_op)
168 .span_label(expr.span, fluent::label)
169 .span_suggestion_verbose(
170 expr.span.shrink_to_lo(),
173 Applicability::MachineApplicable,
179 if !(type_lint_emitted_or_suppressed || fn_warned || op_warned) {
180 cx.struct_span_lint(UNUSED_RESULTS, s.span, fluent::lint_unused_result, |lint| {
181 lint.set_arg("ty", ty)
185 fn check_fn_must_use(cx: &LateContext<'_>, expr: &hir::Expr<'_>) -> bool {
186 let maybe_def_id = match expr.kind {
187 hir::ExprKind::Call(ref callee, _) => {
189 hir::ExprKind::Path(ref qpath) => {
190 match cx.qpath_res(qpath, callee.hir_id) {
191 Res::Def(DefKind::Fn | DefKind::AssocFn, def_id) => Some(def_id),
192 // `Res::Local` if it was a closure, for which we
193 // do not currently support must-use linting
200 hir::ExprKind::MethodCall(..) => {
201 cx.typeck_results().type_dependent_def_id(expr.hir_id)
205 if let Some(def_id) = maybe_def_id {
206 check_must_use_def(cx, def_id, expr.span, "return value of ", "")
212 /// A path through a type to a must_use source. Contains useful info for the lint.
215 /// Suppress must_use checking.
217 /// The root of the normal must_use lint with an optional message.
218 Def(Span, DefId, Option<Symbol>),
221 TraitObject(Box<Self>),
222 TupleElement(Vec<(usize, Self)>),
223 Array(Box<Self>, u64),
224 /// The root of the unused_closures lint.
226 /// The root of the unused_generators lint.
230 #[instrument(skip(cx, expr), level = "debug", ret)]
231 fn is_ty_must_use<'tcx>(
232 cx: &LateContext<'tcx>,
234 expr: &hir::Expr<'_>,
236 ) -> Option<MustUsePath> {
238 || !ty.is_inhabited_from(
240 cx.tcx.parent_module(expr.hir_id).to_def_id(),
244 return Some(MustUsePath::Suppressed);
248 ty::Adt(..) if ty.is_box() => {
249 let boxed_ty = ty.boxed_ty();
250 is_ty_must_use(cx, boxed_ty, expr, span)
251 .map(|inner| MustUsePath::Boxed(Box::new(inner)))
253 ty::Adt(def, _) => is_def_must_use(cx, def.did(), span),
254 ty::Opaque(def, _) => {
255 elaborate_predicates_with_span(
257 cx.tcx.explicit_item_bounds(def).iter().cloned(),
259 .filter_map(|obligation| {
260 // We only look at the `DefId`, so it is safe to skip the binder here.
261 if let ty::PredicateKind::Clause(ty::Clause::Trait(
262 ref poly_trait_predicate,
263 )) = obligation.predicate.kind().skip_binder()
265 let def_id = poly_trait_predicate.trait_ref.def_id;
267 is_def_must_use(cx, def_id, span)
272 .map(|inner| MustUsePath::Opaque(Box::new(inner)))
275 ty::Dynamic(binders, _, _) => binders
277 .filter_map(|predicate| {
278 if let ty::ExistentialPredicate::Trait(ref trait_ref) =
279 predicate.skip_binder()
281 let def_id = trait_ref.def_id;
282 is_def_must_use(cx, def_id, span)
286 .map(|inner| MustUsePath::TraitObject(Box::new(inner)))
290 let elem_exprs = if let hir::ExprKind::Tup(elem_exprs) = expr.kind {
291 debug_assert_eq!(elem_exprs.len(), tys.len());
297 // Default to `expr`.
298 let elem_exprs = elem_exprs.iter().chain(iter::repeat(expr));
300 let nested_must_use = tys
304 .filter_map(|(i, (ty, expr))| {
305 is_ty_must_use(cx, ty, expr, expr.span).map(|path| (i, path))
307 .collect::<Vec<_>>();
309 if !nested_must_use.is_empty() {
310 Some(MustUsePath::TupleElement(nested_must_use))
315 ty::Array(ty, len) => match len.try_eval_usize(cx.tcx, cx.param_env) {
316 // If the array is empty we don't lint, to avoid false positives
317 Some(0) | None => None,
318 // If the array is definitely non-empty, we can do `#[must_use]` checking.
319 Some(len) => is_ty_must_use(cx, ty, expr, span)
320 .map(|inner| MustUsePath::Array(Box::new(inner), len)),
322 ty::Closure(..) => Some(MustUsePath::Closure(span)),
323 ty::Generator(def_id, ..) => {
324 // async fn should be treated as "implementor of `Future`"
325 let must_use = if cx.tcx.generator_is_async(def_id) {
326 let def_id = cx.tcx.lang_items().future_trait().unwrap();
327 is_def_must_use(cx, def_id, span)
328 .map(|inner| MustUsePath::Opaque(Box::new(inner)))
332 must_use.or(Some(MustUsePath::Generator(span)))
338 fn is_def_must_use(cx: &LateContext<'_>, def_id: DefId, span: Span) -> Option<MustUsePath> {
339 if let Some(attr) = cx.tcx.get_attr(def_id, sym::must_use) {
340 // check for #[must_use = "..."]
341 let reason = attr.value_str();
342 Some(MustUsePath::Def(span, def_id, reason))
348 // Returns whether further errors should be suppressed because either a lint has been emitted or the type should be ignored.
349 fn check_must_use_def(
350 cx: &LateContext<'_>,
353 descr_pre_path: &str,
354 descr_post_path: &str,
356 is_def_must_use(cx, def_id, span)
357 .map(|must_use_path| {
358 emit_must_use_untranslated(
369 #[instrument(skip(cx), level = "debug")]
370 fn emit_must_use_untranslated(
371 cx: &LateContext<'_>,
377 let plural_suffix = pluralize!(plural_len);
380 MustUsePath::Suppressed => {}
381 MustUsePath::Boxed(path) => {
382 let descr_pre = &format!("{}boxed ", descr_pre);
383 emit_must_use_untranslated(cx, path, descr_pre, descr_post, plural_len);
385 MustUsePath::Opaque(path) => {
386 let descr_pre = &format!("{}implementer{} of ", descr_pre, plural_suffix);
387 emit_must_use_untranslated(cx, path, descr_pre, descr_post, plural_len);
389 MustUsePath::TraitObject(path) => {
390 let descr_post = &format!(" trait object{}{}", plural_suffix, descr_post);
391 emit_must_use_untranslated(cx, path, descr_pre, descr_post, plural_len);
393 MustUsePath::TupleElement(elems) => {
394 for (index, path) in elems {
395 let descr_post = &format!(" in tuple element {}", index);
396 emit_must_use_untranslated(cx, path, descr_pre, descr_post, plural_len);
399 MustUsePath::Array(path, len) => {
400 let descr_pre = &format!("{}array{} of ", descr_pre, plural_suffix);
401 emit_must_use_untranslated(
406 plural_len.saturating_add(usize::try_from(*len).unwrap_or(usize::MAX)),
409 MustUsePath::Closure(span) => {
413 fluent::lint_unused_closure,
415 // FIXME(davidtwco): this isn't properly translatable because of the
417 lint.set_arg("count", plural_len)
418 .set_arg("pre", descr_pre)
419 .set_arg("post", descr_post)
424 MustUsePath::Generator(span) => {
428 fluent::lint_unused_generator,
430 // FIXME(davidtwco): this isn't properly translatable because of the
432 lint.set_arg("count", plural_len)
433 .set_arg("pre", descr_pre)
434 .set_arg("post", descr_post)
439 MustUsePath::Def(span, def_id, reason) => {
440 cx.struct_span_lint(UNUSED_MUST_USE, *span, fluent::lint_unused_def, |lint| {
441 // FIXME(davidtwco): this isn't properly translatable because of the pre/post
443 lint.set_arg("pre", descr_pre);
444 lint.set_arg("post", descr_post);
445 lint.set_arg("def", cx.tcx.def_path_str(*def_id));
446 if let Some(note) = reason {
447 lint.note(note.as_str());
458 /// The `path_statements` lint detects path statements with no effect.
472 /// It is usually a mistake to have a statement that has no effect.
475 "path statements with no effect"
478 declare_lint_pass!(PathStatements => [PATH_STATEMENTS]);
480 impl<'tcx> LateLintPass<'tcx> for PathStatements {
481 fn check_stmt(&mut self, cx: &LateContext<'_>, s: &hir::Stmt<'_>) {
482 if let hir::StmtKind::Semi(expr) = s.kind {
483 if let hir::ExprKind::Path(_) = expr.kind {
484 let ty = cx.typeck_results().expr_ty(expr);
485 if ty.needs_drop(cx.tcx, cx.param_env) {
489 fluent::lint_path_statement_drop,
491 if let Ok(snippet) = cx.sess().source_map().span_to_snippet(expr.span) {
492 lint.span_suggestion(
495 format!("drop({});", snippet),
496 Applicability::MachineApplicable,
499 lint.span_help(s.span, fluent::suggestion);
508 fluent::lint_path_statement_no_effect,
517 #[derive(Copy, Clone, Debug, PartialEq, Eq)]
518 enum UnusedDelimsCtx {
522 AssignedValueLetElse,
535 impl From<UnusedDelimsCtx> for &'static str {
536 fn from(ctx: UnusedDelimsCtx) -> &'static str {
538 UnusedDelimsCtx::FunctionArg => "function argument",
539 UnusedDelimsCtx::MethodArg => "method argument",
540 UnusedDelimsCtx::AssignedValue | UnusedDelimsCtx::AssignedValueLetElse => {
543 UnusedDelimsCtx::IfCond => "`if` condition",
544 UnusedDelimsCtx::WhileCond => "`while` condition",
545 UnusedDelimsCtx::ForIterExpr => "`for` iterator expression",
546 UnusedDelimsCtx::MatchScrutineeExpr => "`match` scrutinee expression",
547 UnusedDelimsCtx::ReturnValue => "`return` value",
548 UnusedDelimsCtx::BlockRetValue => "block return value",
549 UnusedDelimsCtx::LetScrutineeExpr => "`let` scrutinee expression",
550 UnusedDelimsCtx::ArrayLenExpr | UnusedDelimsCtx::AnonConst => "const expression",
551 UnusedDelimsCtx::MatchArmExpr => "match arm expression",
556 /// Used by both `UnusedParens` and `UnusedBraces` to prevent code duplication.
557 trait UnusedDelimLint {
558 const DELIM_STR: &'static str;
560 /// Due to `ref` pattern, there can be a difference between using
561 /// `{ expr }` and `expr` in pattern-matching contexts. This means
562 /// that we should only lint `unused_parens` and not `unused_braces`
567 /// let ref b = { a }; // We actually borrow a copy of `a` here.
568 /// a += 1; // By mutating `a` we invalidate any borrows of `a`.
569 /// assert_eq!(b + 1, a); // `b` does not borrow `a`, so we can still use it here.
571 const LINT_EXPR_IN_PATTERN_MATCHING_CTX: bool;
573 // this cannot be a constant is it refers to a static.
574 fn lint(&self) -> &'static Lint;
576 fn check_unused_delims_expr(
578 cx: &EarlyContext<'_>,
580 ctx: UnusedDelimsCtx,
581 followed_by_block: bool,
582 left_pos: Option<BytePos>,
583 right_pos: Option<BytePos>,
586 fn is_expr_delims_necessary(
588 followed_by_block: bool,
589 followed_by_else: bool,
591 if followed_by_else {
593 ast::ExprKind::Binary(op, ..) if op.node.lazy() => return true,
594 _ if classify::expr_trailing_brace(inner).is_some() => return true,
599 // Prevent false-positives in cases like `fn x() -> u8 { ({ 0 } + 1) }`
600 let lhs_needs_parens = {
601 let mut innermost = inner;
603 innermost = match &innermost.kind {
604 ExprKind::Binary(_, lhs, _rhs) => lhs,
605 ExprKind::Call(fn_, _params) => fn_,
606 ExprKind::Cast(expr, _ty) => expr,
607 ExprKind::Type(expr, _ty) => expr,
608 ExprKind::Index(base, _subscript) => base,
611 if !classify::expr_requires_semi_to_be_stmt(innermost) {
618 || (followed_by_block
619 && match &inner.kind {
620 ExprKind::Ret(_) | ExprKind::Break(..) | ExprKind::Yield(..) => true,
621 ExprKind::Range(_lhs, Some(rhs), _limits) => {
622 matches!(rhs.kind, ExprKind::Block(..))
624 _ => parser::contains_exterior_struct_lit(&inner),
628 fn emit_unused_delims_expr(
630 cx: &EarlyContext<'_>,
632 ctx: UnusedDelimsCtx,
633 left_pos: Option<BytePos>,
634 right_pos: Option<BytePos>,
636 let spans = match value.kind {
637 ast::ExprKind::Block(ref block, None) if block.stmts.len() == 1 => {
638 if let StmtKind::Expr(expr) = &block.stmts[0].kind
639 && let ExprKind::Err = expr.kind
643 if let Some(span) = block.stmts[0].span.find_ancestor_inside(value.span) {
644 Some((value.span.with_hi(span.lo()), value.span.with_lo(span.hi())))
649 ast::ExprKind::Paren(ref expr) => {
650 let expr_span = expr.span.find_ancestor_inside(value.span);
651 if let Some(expr_span) = expr_span {
652 Some((value.span.with_hi(expr_span.lo()), value.span.with_lo(expr_span.hi())))
660 left_pos.map_or(false, |s| s >= value.span.lo()),
661 right_pos.map_or(false, |s| s <= value.span.hi()),
663 self.emit_unused_delims(cx, value.span, spans, ctx.into(), keep_space);
666 fn emit_unused_delims(
668 cx: &EarlyContext<'_>,
670 spans: Option<(Span, Span)>,
672 keep_space: (bool, bool),
674 let primary_span = if let Some((lo, hi)) = spans {
675 MultiSpan::from(vec![lo, hi])
677 MultiSpan::from(value_span)
679 cx.struct_span_lint(self.lint(), primary_span, fluent::lint_unused_delim, |lint| {
680 lint.set_arg("delim", Self::DELIM_STR);
681 lint.set_arg("item", msg);
682 if let Some((lo, hi)) = spans {
683 let sm = cx.sess().source_map();
686 let Ok(snip) = sm.span_to_prev_source(lo) && !snip.ends_with(' ') {
694 let Ok(snip) = sm.span_to_next_source(hi) && !snip.starts_with(' ') {
700 let replacement = vec![(lo, lo_replace), (hi, hi_replace)];
701 lint.multipart_suggestion(
704 Applicability::MachineApplicable,
711 fn check_expr(&mut self, cx: &EarlyContext<'_>, e: &ast::Expr) {
712 use rustc_ast::ExprKind::*;
713 let (value, ctx, followed_by_block, left_pos, right_pos) = match e.kind {
714 // Do not lint `unused_braces` in `if let` expressions.
715 If(ref cond, ref block, _)
716 if !matches!(cond.kind, Let(_, _, _))
717 || Self::LINT_EXPR_IN_PATTERN_MATCHING_CTX =>
719 let left = e.span.lo() + rustc_span::BytePos(2);
720 let right = block.span.lo();
721 (cond, UnusedDelimsCtx::IfCond, true, Some(left), Some(right))
724 // Do not lint `unused_braces` in `while let` expressions.
725 While(ref cond, ref block, ..)
726 if !matches!(cond.kind, Let(_, _, _))
727 || Self::LINT_EXPR_IN_PATTERN_MATCHING_CTX =>
729 let left = e.span.lo() + rustc_span::BytePos(5);
730 let right = block.span.lo();
731 (cond, UnusedDelimsCtx::WhileCond, true, Some(left), Some(right))
734 ForLoop(_, ref cond, ref block, ..) => {
735 (cond, UnusedDelimsCtx::ForIterExpr, true, None, Some(block.span.lo()))
738 Match(ref head, _) if Self::LINT_EXPR_IN_PATTERN_MATCHING_CTX => {
739 let left = e.span.lo() + rustc_span::BytePos(5);
740 (head, UnusedDelimsCtx::MatchScrutineeExpr, true, Some(left), None)
743 Ret(Some(ref value)) => {
744 let left = e.span.lo() + rustc_span::BytePos(3);
745 (value, UnusedDelimsCtx::ReturnValue, false, Some(left), None)
748 Assign(_, ref value, _) | AssignOp(.., ref value) => {
749 (value, UnusedDelimsCtx::AssignedValue, false, None, None)
751 // either function/method call, or something this lint doesn't care about
752 ref call_or_other => {
753 let (args_to_check, ctx) = match *call_or_other {
754 Call(_, ref args) => (&args[..], UnusedDelimsCtx::FunctionArg),
755 MethodCall(ref call) => (&call.args[..], UnusedDelimsCtx::MethodArg),
756 // actual catch-all arm
761 // Don't lint if this is a nested macro expansion: otherwise, the lint could
762 // trigger in situations that macro authors shouldn't have to care about, e.g.,
763 // when a parenthesized token tree matched in one macro expansion is matched as
764 // an expression in another and used as a fn/method argument (Issue #47775)
765 if e.span.ctxt().outer_expn_data().call_site.from_expansion() {
768 for arg in args_to_check {
769 self.check_unused_delims_expr(cx, arg, ctx, false, None, None);
774 self.check_unused_delims_expr(cx, &value, ctx, followed_by_block, left_pos, right_pos);
777 fn check_stmt(&mut self, cx: &EarlyContext<'_>, s: &ast::Stmt) {
779 StmtKind::Local(ref local) if Self::LINT_EXPR_IN_PATTERN_MATCHING_CTX => {
780 if let Some((init, els)) = local.kind.init_else_opt() {
781 let ctx = match els {
782 None => UnusedDelimsCtx::AssignedValue,
783 Some(_) => UnusedDelimsCtx::AssignedValueLetElse,
785 self.check_unused_delims_expr(cx, init, ctx, false, None, None);
788 StmtKind::Expr(ref expr) => {
789 self.check_unused_delims_expr(
792 UnusedDelimsCtx::BlockRetValue,
802 fn check_item(&mut self, cx: &EarlyContext<'_>, item: &ast::Item) {
803 use ast::ItemKind::*;
805 if let Const(.., Some(expr)) | Static(.., Some(expr)) = &item.kind {
806 self.check_unused_delims_expr(
809 UnusedDelimsCtx::AssignedValue,
819 /// The `unused_parens` lint detects `if`, `match`, `while` and `return`
820 /// with parentheses; they do not need them.
832 /// The parentheses are not needed, and should be removed. This is the
833 /// preferred style for writing these expressions.
834 pub(super) UNUSED_PARENS,
836 "`if`, `match`, `while` and `return` do not need parentheses"
839 declare_lint_pass!(UnusedParens => [UNUSED_PARENS]);
841 impl UnusedDelimLint for UnusedParens {
842 const DELIM_STR: &'static str = "parentheses";
844 const LINT_EXPR_IN_PATTERN_MATCHING_CTX: bool = true;
846 fn lint(&self) -> &'static Lint {
850 fn check_unused_delims_expr(
852 cx: &EarlyContext<'_>,
854 ctx: UnusedDelimsCtx,
855 followed_by_block: bool,
856 left_pos: Option<BytePos>,
857 right_pos: Option<BytePos>,
860 ast::ExprKind::Paren(ref inner) => {
861 let followed_by_else = ctx == UnusedDelimsCtx::AssignedValueLetElse;
862 if !Self::is_expr_delims_necessary(inner, followed_by_block, followed_by_else)
863 && value.attrs.is_empty()
864 && !value.span.from_expansion()
865 && (ctx != UnusedDelimsCtx::LetScrutineeExpr
866 || !matches!(inner.kind, ast::ExprKind::Binary(
867 rustc_span::source_map::Spanned { node, .. },
872 self.emit_unused_delims_expr(cx, value, ctx, left_pos, right_pos)
875 ast::ExprKind::Let(_, ref expr, _) => {
876 self.check_unused_delims_expr(
879 UnusedDelimsCtx::LetScrutineeExpr,
891 fn check_unused_parens_pat(
893 cx: &EarlyContext<'_>,
897 keep_space: (bool, bool),
899 use ast::{BindingAnnotation, PatKind};
901 if let PatKind::Paren(inner) = &value.kind {
903 // The lint visitor will visit each subpattern of `p`. We do not want to lint
904 // any range pattern no matter where it occurs in the pattern. For something like
905 // `&(a..=b)`, there is a recursive `check_pat` on `a` and `b`, but we will assume
906 // that if there are unnecessary parens they serve a purpose of readability.
907 PatKind::Range(..) => return,
908 // Avoid `p0 | .. | pn` if we should.
909 PatKind::Or(..) if avoid_or => return,
910 // Avoid `mut x` and `mut x @ p` if we should:
911 PatKind::Ident(BindingAnnotation::MUT, ..) if avoid_mut => {
914 // Otherwise proceed with linting.
917 let spans = if let Some(inner) = inner.span.find_ancestor_inside(value.span) {
918 Some((value.span.with_hi(inner.lo()), value.span.with_lo(inner.hi())))
922 self.emit_unused_delims(cx, value.span, spans, "pattern", keep_space);
927 impl EarlyLintPass for UnusedParens {
928 fn check_expr(&mut self, cx: &EarlyContext<'_>, e: &ast::Expr) {
930 ExprKind::Let(ref pat, _, _) | ExprKind::ForLoop(ref pat, ..) => {
931 self.check_unused_parens_pat(cx, pat, false, false, (true, true));
933 // We ignore parens in cases like `if (((let Some(0) = Some(1))))` because we already
934 // handle a hard error for them during AST lowering in `lower_expr_mut`, but we still
935 // want to complain about things like `if let 42 = (42)`.
936 ExprKind::If(ref cond, ref block, ref else_)
937 if matches!(cond.peel_parens().kind, ExprKind::Let(..)) =>
939 self.check_unused_delims_expr(
942 UnusedDelimsCtx::LetScrutineeExpr,
947 for stmt in &block.stmts {
948 <Self as UnusedDelimLint>::check_stmt(self, cx, stmt);
950 if let Some(e) = else_ {
951 <Self as UnusedDelimLint>::check_expr(self, cx, e);
955 ExprKind::Match(ref _expr, ref arm) => {
957 self.check_unused_delims_expr(
960 UnusedDelimsCtx::MatchArmExpr,
970 <Self as UnusedDelimLint>::check_expr(self, cx, e)
973 fn check_pat(&mut self, cx: &EarlyContext<'_>, p: &ast::Pat) {
974 use ast::{Mutability, PatKind::*};
975 let keep_space = (false, false);
977 // Do not lint on `(..)` as that will result in the other arms being useless.
979 // The other cases do not contain sub-patterns.
980 | Wild | Rest | Lit(..) | MacCall(..) | Range(..) | Ident(.., None) | Path(..) => {},
981 // These are list-like patterns; parens can always be removed.
982 TupleStruct(_, _, ps) | Tuple(ps) | Slice(ps) | Or(ps) => for p in ps {
983 self.check_unused_parens_pat(cx, p, false, false, keep_space);
985 Struct(_, _, fps, _) => for f in fps {
986 self.check_unused_parens_pat(cx, &f.pat, false, false, keep_space);
988 // Avoid linting on `i @ (p0 | .. | pn)` and `box (p0 | .. | pn)`, #64106.
989 Ident(.., Some(p)) | Box(p) => self.check_unused_parens_pat(cx, p, true, false, keep_space),
990 // Avoid linting on `&(mut x)` as `&mut x` has a different meaning, #55342.
991 // Also avoid linting on `& mut? (p0 | .. | pn)`, #64106.
992 Ref(p, m) => self.check_unused_parens_pat(cx, p, true, *m == Mutability::Not, keep_space),
996 fn check_stmt(&mut self, cx: &EarlyContext<'_>, s: &ast::Stmt) {
997 if let StmtKind::Local(ref local) = s.kind {
998 self.check_unused_parens_pat(cx, &local.pat, true, false, (false, false));
1001 <Self as UnusedDelimLint>::check_stmt(self, cx, s)
1004 fn check_param(&mut self, cx: &EarlyContext<'_>, param: &ast::Param) {
1005 self.check_unused_parens_pat(cx, ¶m.pat, true, false, (false, false));
1008 fn check_arm(&mut self, cx: &EarlyContext<'_>, arm: &ast::Arm) {
1009 self.check_unused_parens_pat(cx, &arm.pat, false, false, (false, false));
1012 fn check_ty(&mut self, cx: &EarlyContext<'_>, ty: &ast::Ty) {
1013 if let ast::TyKind::Paren(r) = &ty.kind {
1015 ast::TyKind::TraitObject(..) => {}
1016 ast::TyKind::BareFn(b) if b.generic_params.len() > 0 => {}
1017 ast::TyKind::ImplTrait(_, bounds) if bounds.len() > 1 => {}
1018 ast::TyKind::Array(_, len) => {
1019 self.check_unused_delims_expr(
1022 UnusedDelimsCtx::ArrayLenExpr,
1029 let spans = if let Some(r) = r.span.find_ancestor_inside(ty.span) {
1030 Some((ty.span.with_hi(r.lo()), ty.span.with_lo(r.hi())))
1034 self.emit_unused_delims(cx, ty.span, spans, "type", (false, false));
1040 fn check_item(&mut self, cx: &EarlyContext<'_>, item: &ast::Item) {
1041 <Self as UnusedDelimLint>::check_item(self, cx, item)
1046 /// The `unused_braces` lint detects unnecessary braces around an
1061 /// The braces are not needed, and should be removed. This is the
1062 /// preferred style for writing these expressions.
1063 pub(super) UNUSED_BRACES,
1065 "unnecessary braces around an expression"
1068 declare_lint_pass!(UnusedBraces => [UNUSED_BRACES]);
1070 impl UnusedDelimLint for UnusedBraces {
1071 const DELIM_STR: &'static str = "braces";
1073 const LINT_EXPR_IN_PATTERN_MATCHING_CTX: bool = false;
1075 fn lint(&self) -> &'static Lint {
1079 fn check_unused_delims_expr(
1081 cx: &EarlyContext<'_>,
1083 ctx: UnusedDelimsCtx,
1084 followed_by_block: bool,
1085 left_pos: Option<BytePos>,
1086 right_pos: Option<BytePos>,
1089 ast::ExprKind::Block(ref inner, None)
1090 if inner.rules == ast::BlockCheckMode::Default =>
1092 // emit a warning under the following conditions:
1094 // - the block does not have a label
1095 // - the block is not `unsafe`
1096 // - the block contains exactly one expression (do not lint `{ expr; }`)
1097 // - `followed_by_block` is true and the internal expr may contain a `{`
1098 // - the block is not multiline (do not lint multiline match arms)
1102 // somewhat_long_expression
1107 // - the block has no attribute and was not created inside a macro
1108 // - if the block is an `anon_const`, the inner expr must be a literal
1109 // (do not lint `struct A<const N: usize>; let _: A<{ 2 + 3 }>;`)
1111 // FIXME(const_generics): handle paths when #67075 is fixed.
1112 if let [stmt] = inner.stmts.as_slice() {
1113 if let ast::StmtKind::Expr(ref expr) = stmt.kind {
1114 if !Self::is_expr_delims_necessary(expr, followed_by_block, false)
1115 && (ctx != UnusedDelimsCtx::AnonConst
1116 || matches!(expr.kind, ast::ExprKind::Lit(_)))
1117 && !cx.sess().source_map().is_multiline(value.span)
1118 && value.attrs.is_empty()
1119 && !value.span.from_expansion()
1121 self.emit_unused_delims_expr(cx, value, ctx, left_pos, right_pos)
1126 ast::ExprKind::Let(_, ref expr, _) => {
1127 self.check_unused_delims_expr(
1130 UnusedDelimsCtx::LetScrutineeExpr,
1141 impl EarlyLintPass for UnusedBraces {
1142 fn check_stmt(&mut self, cx: &EarlyContext<'_>, s: &ast::Stmt) {
1143 <Self as UnusedDelimLint>::check_stmt(self, cx, s)
1146 fn check_expr(&mut self, cx: &EarlyContext<'_>, e: &ast::Expr) {
1147 <Self as UnusedDelimLint>::check_expr(self, cx, e);
1149 if let ExprKind::Repeat(_, ref anon_const) = e.kind {
1150 self.check_unused_delims_expr(
1153 UnusedDelimsCtx::AnonConst,
1161 fn check_generic_arg(&mut self, cx: &EarlyContext<'_>, arg: &ast::GenericArg) {
1162 if let ast::GenericArg::Const(ct) = arg {
1163 self.check_unused_delims_expr(
1166 UnusedDelimsCtx::AnonConst,
1174 fn check_variant(&mut self, cx: &EarlyContext<'_>, v: &ast::Variant) {
1175 if let Some(anon_const) = &v.disr_expr {
1176 self.check_unused_delims_expr(
1179 UnusedDelimsCtx::AnonConst,
1187 fn check_ty(&mut self, cx: &EarlyContext<'_>, ty: &ast::Ty) {
1189 ast::TyKind::Array(_, ref len) => {
1190 self.check_unused_delims_expr(
1193 UnusedDelimsCtx::ArrayLenExpr,
1200 ast::TyKind::Typeof(ref anon_const) => {
1201 self.check_unused_delims_expr(
1204 UnusedDelimsCtx::AnonConst,
1215 fn check_item(&mut self, cx: &EarlyContext<'_>, item: &ast::Item) {
1216 <Self as UnusedDelimLint>::check_item(self, cx, item)
1221 /// The `unused_import_braces` lint catches unnecessary braces around an
1226 /// ```rust,compile_fail
1227 /// #![deny(unused_import_braces)]
1240 /// If there is only a single item, then remove the braces (`use test::A;`
1243 /// This lint is "allow" by default because it is only enforcing a
1244 /// stylistic choice.
1245 UNUSED_IMPORT_BRACES,
1247 "unnecessary braces around an imported item"
1250 declare_lint_pass!(UnusedImportBraces => [UNUSED_IMPORT_BRACES]);
1252 impl UnusedImportBraces {
1253 fn check_use_tree(&self, cx: &EarlyContext<'_>, use_tree: &ast::UseTree, item: &ast::Item) {
1254 if let ast::UseTreeKind::Nested(ref items) = use_tree.kind {
1255 // Recursively check nested UseTrees
1256 for &(ref tree, _) in items {
1257 self.check_use_tree(cx, tree, item);
1260 // Trigger the lint only if there is one nested item
1261 if items.len() != 1 {
1265 // Trigger the lint if the nested item is a non-self single item
1266 let node_name = match items[0].0.kind {
1267 ast::UseTreeKind::Simple(rename, ..) => {
1268 let orig_ident = items[0].0.prefix.segments.last().unwrap().ident;
1269 if orig_ident.name == kw::SelfLower {
1272 rename.unwrap_or(orig_ident).name
1274 ast::UseTreeKind::Glob => Symbol::intern("*"),
1275 ast::UseTreeKind::Nested(_) => return,
1278 cx.struct_span_lint(
1279 UNUSED_IMPORT_BRACES,
1281 fluent::lint_unused_import_braces,
1282 |lint| lint.set_arg("node", node_name),
1288 impl EarlyLintPass for UnusedImportBraces {
1289 fn check_item(&mut self, cx: &EarlyContext<'_>, item: &ast::Item) {
1290 if let ast::ItemKind::Use(ref use_tree) = item.kind {
1291 self.check_use_tree(cx, use_tree, item);
1297 /// The `unused_allocation` lint detects unnecessary allocations that can
1303 /// #![feature(box_syntax)]
1305 /// let a = (box [1, 2, 3]).len();
1313 /// When a `box` expression is immediately coerced to a reference, then
1314 /// the allocation is unnecessary, and a reference (using `&` or `&mut`)
1315 /// should be used instead to avoid the allocation.
1316 pub(super) UNUSED_ALLOCATION,
1318 "detects unnecessary allocations that can be eliminated"
1321 declare_lint_pass!(UnusedAllocation => [UNUSED_ALLOCATION]);
1323 impl<'tcx> LateLintPass<'tcx> for UnusedAllocation {
1324 fn check_expr(&mut self, cx: &LateContext<'_>, e: &hir::Expr<'_>) {
1326 hir::ExprKind::Box(_) => {}
1330 for adj in cx.typeck_results().expr_adjustments(e) {
1331 if let adjustment::Adjust::Borrow(adjustment::AutoBorrow::Ref(_, m)) = adj.kind {
1332 cx.struct_span_lint(
1336 adjustment::AutoBorrowMutability::Not => fluent::lint_unused_allocation,
1337 adjustment::AutoBorrowMutability::Mut { .. } => {
1338 fluent::lint_unused_allocation_mut