Warnings on missing .create() #113
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
This results in the Mock never being registered to the server, which is most likely a mistake
Warns about neglecting to assign the Mock to a variable as per docs
|
@dbr looks great, thanks 🥇 |
dimo414
reviewed
Jan 25, 2021
| @@ -1064,20 +1068,21 @@ impl Mock { | |||
| /// let _m = mock("GET", "/").with_body("hello world").create(); | |||
| /// ``` | |||
| /// | |||
| pub fn create(self) -> Self { | |||
| #[must_use] | |||
There was a problem hiding this comment.
I don't think this does what you intend. This ensures someone who calls create() uses the result (Self), but doesn't require that create() itself is called. And since the intended pattern is to bind the Mock to an unused variable (let _m = mock(...);) that satisfies the must_use requirement, so normal usage won't see this.
For example:
mock("GET", "/").with_status(200); // No warning
mock("GET", "/").with_status(200).create(); // Warning: must_use
let _m = mock("GET", "/").with_status(200); // No warning
let _m = mock("GET", "/").with_status(200).create(); // No warning
Arguably all the builder methods on Mock should be #[must_use], but it still won't ensure that .create() is called.
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.
As discussed in #112