blob: 4a4fd2c6e517b86dafd0f253542318eccc9bfede (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
|
### What it does
This lint warns when a method returning `Self` doesn't have the `#[must_use]` attribute.
### Why is this bad?
Methods returning `Self` often create new values, having the `#[must_use]` attribute
prevents users from "forgetting" to use the newly created value.
The `#[must_use]` attribute can be added to the type itself to ensure that instances
are never forgotten. Functions returning a type marked with `#[must_use]` will not be
linted, as the usage is already enforced by the type attribute.
### Limitations
This lint is only applied on methods taking a `self` argument. It would be mostly noise
if it was added on constructors for example.
### Example
```
pub struct Bar;
impl Bar {
// Missing attribute
pub fn bar(&self) -> Self {
Self
}
}
```
Use instead:
```
// It's better to have the `#[must_use]` attribute on the method like this:
pub struct Bar;
impl Bar {
#[must_use]
pub fn bar(&self) -> Self {
Self
}
}
// Or on the type definition like this:
#[must_use]
pub struct Bar;
impl Bar {
pub fn bar(&self) -> Self {
Self
}
}
```
|
