Add must_use to the Reference

rust-lang · Aug 17, 2016 · 0384722 · 0384722
1 parent 6c0d66a
commit 0384722
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/doc/reference.md b/src/doc/reference.md
@@ -2070,6 +2070,9 @@ macro scope.
    trait of the same name. `{Self}` will be replaced with the type that is supposed
    to implement the trait but doesn't. To use this, the `on_unimplemented` feature gate
    must be enabled.
+- `must_use` - on structs and enums, will warn if a value of this type isn't used or
+   assigned to a variable. You may also include an optional message by using
+   `#[must_use = "message"]` which will be given alongside the warning.
 
 ### Conditional compilation