Skip to content

Commit

Permalink
unstable book section for fn_must_use
Browse files Browse the repository at this point in the history
  • Loading branch information
zackmdavis committed Sep 16, 2017
1 parent e9569d9 commit d09db63
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions src/doc/unstable-book/src/language-features/fn-must-use.md
@@ -0,0 +1,30 @@
# `fn_must_use`

The tracking issue for this feature is [#43302].

[#43302]: https://github.com/rust-lang/rust/issues/43302

------------------------

The `fn_must_use` feature allows functions and methods to be annotated with
`#[must_use]`, indicating that the `unused_must_use` lint should require their
return values to be used (similarly to how types annotated with `must_use`,
most notably `Result`, are linted if not used).

## Examples

```rust
#![feature(fn_must_use)]

#[must_use]
fn double(x: i32) -> i32 {
2 * x
}

fn main() {
double(4); // warning: unused return value of `double` which must be used

let _ = double(4); // (no warning)
}

```

0 comments on commit d09db63

Please sign in to comment.