Add must_use attribute to Mock
#135
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
It's easy to forget to mount a mock to a server, even though the docs call this out. This commit tags the `Mock` struct with [`#[must_use]`][reference], so that Rust itself can warn users when they forget to mount their mocks. The help string
Here's the warning emitted:
```
warning: unused `Mock` that must be used
--> examples\must_use.rs:9:5
|
9 | Mock::given(method("GET")).respond_with(response.clone());
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
= note: `Mock`s have to be mounted or registered with a `MockServer` to become effective
= note: `#[warn(unused_must_use)]` on by default
help: use `let _ = ...` to ignore the resulting value
|
9 | let _ = Mock::given(method("GET")).respond_with(response.clone());
| +++++++
```
[reference]: https://doc.rust-lang.org/reference/attributes/diagnostics.html#the-must_use-attribute
|
Guessing these are new lints, pretty sure they're not related to my change. Might be able to make a pr fixing them for you this evening if you want. |
|
That'd be nice if you have the time! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of changes:
It's easy to forget to mount a mock to a server, even though the docs call this out. This commit tags the
Mockstruct with#[must_use], so that Rust itself can warn users when they forget to mount their mocks. The help stringHere's the warning emitted:
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.