Document the fact that debug_handler doesn't work within impl blocks
#1800
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
davidpdrsn
reviewed
Mar 2, 2023
davidpdrsn
approved these changes
Mar 3, 2023
jesjos
commented
Mar 3, 2023
Comment on lines
+545
to
+546
| /// This macro does not work for associated functions — functions defined in an `impl` block that | ||
| /// don't take `self`: |
There was a problem hiding this comment.
Suggested change
| /// This macro does not work for associated functions — functions defined in an `impl` block that | |
| /// don't take `self`: | |
| /// This macro does not work for associated functions that aren't methods — functions defined in an `impl` block that | |
| /// don't take `self`: |
There was a problem hiding this comment.
But an associated function is never a method 🤔
There was a problem hiding this comment.
I added this clarification @davidpdrsn — maybe I'm splitting hairs, but I think it pays to try and get it right
There was a problem hiding this comment.
https://doc.rust-lang.org/reference/items/associated-items.html#methods
Associated functions whose first parameter is named self are called methods and may be invoked using the method call operator, for example, x.foo(), as well as the usual function call notation.
There was a problem hiding this comment.
Suggested change
| /// This macro does not work for associated functions — functions defined in an `impl` block that | |
| /// don't take `self`: | |
| /// This macro does not work functions in an `impl` block that | |
| /// don't have a `self` parameter: |
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.
Motivation
When upgrading from from axum 0.5.x to 0.6.x I encountered a breaking change to how the
debug_handlermacro works.In 0.5.x, an associated function (not a method) could be used with
debug_handler. In 0.6.x this yields confusing compilation errors.As per @davidpdrsn on Discord:
Solution
This PR attempts to document this behavior.