Skip to content

Commit

Permalink
#[must_use] for functions (RFC 1940)
Browse files Browse the repository at this point in the history
The return value of a function annotated with `must_use`, must be used.

This is in the matter of #43302.
  • Loading branch information
zackmdavis committed Aug 8, 2017
1 parent 0188ec6 commit 3645b06
Show file tree
Hide file tree
Showing 3 changed files with 72 additions and 9 deletions.
34 changes: 25 additions & 9 deletions src/librustc_lint/unused.rs
Original file line number Diff line number Diff line change
Expand Up @@ -145,22 +145,38 @@ impl<'a, 'tcx> LateLintPass<'a, 'tcx> for UnusedResults {
}

let t = cx.tables.expr_ty(&expr);
let warned = match t.sty {
ty::TyTuple(ref tys, _) if tys.is_empty() => return,
ty::TyNever => return,
ty::TyBool => return,
ty::TyAdt(def, _) => check_must_use(cx, def.did, s.span),
let ty_warned = match t.sty {
ty::TyAdt(def, _) => check_must_use(cx, def.did, s.span, ""),
_ => false,
};
if !warned {

let mut fn_warned = false;
let maybe_def = match expr.node {
hir::ExprCall(ref callee, _) => {
match callee.node {
hir::ExprPath(ref qpath) => Some(cx.tables.qpath_def(qpath, callee.id)),
_ => None
}
},
hir::ExprMethodCall(..) => {
cx.tables.type_dependent_defs.get(&expr.id).cloned()
},
_ => { None }
};
if let Some(def) = maybe_def {
let def_id = def.def_id();
fn_warned = check_must_use(cx, def_id, s.span, "return value of ");
}

if !(ty_warned || fn_warned) {
cx.span_lint(UNUSED_RESULTS, s.span, "unused result");
}

fn check_must_use(cx: &LateContext, def_id: DefId, sp: Span) -> bool {
fn check_must_use(cx: &LateContext, def_id: DefId, sp: Span, describe_path: &str) -> bool {
for attr in cx.tcx.get_attrs(def_id).iter() {
if attr.check_name("must_use") {
let mut msg = format!("unused `{}` which must be used",
cx.tcx.item_path_str(def_id));
let mut msg = format!("unused {}`{}` which must be used",
describe_path, cx.tcx.item_path_str(def_id));
// check for #[must_use="..."]
if let Some(s) = attr.value_str() {
msg.push_str(": ");
Expand Down
33 changes: 33 additions & 0 deletions src/test/ui/lint/fn_must_use.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
// Copyright 2017 The Rust Project Developers. See the COPYRIGHT
// file at the top-level directory of this distribution and at
// http://rust-lang.org/COPYRIGHT.
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.


struct MyStruct {
n: usize
}

impl MyStruct {
#[must_use]
fn need_to_use_this_method_value(&self) -> usize {
self.n
}
}

#[must_use="it's important"]
fn need_to_use_this_value() -> bool {
false
}

fn main() {
need_to_use_this_value();

let m = MyStruct { n: 2 };
m.need_to_use_this_method_value();
}
14 changes: 14 additions & 0 deletions src/test/ui/lint/fn_must_use.stderr
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
warning: unused return value of `need_to_use_this_value` which must be used: it's important
--> $DIR/fn_must_use.rs:29:5
|
29 | need_to_use_this_value();
| ^^^^^^^^^^^^^^^^^^^^^^^^^
|
= note: #[warn(unused_must_use)] on by default

warning: unused return value of `MyStruct::need_to_use_this_method_value` which must be used
--> $DIR/fn_must_use.rs:32:5
|
32 | m.need_to_use_this_method_value();
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

0 comments on commit 3645b06

Please sign in to comment.