[doc] Added notes about extractor precedence #1324
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
Both JSON and Form extractors consume the Body when they run, so they need to be last in the order of extractors. Added a note in the structs docs themselves pointing to the relevant part of the documentation.
davidpdrsn
requested changes
Aug 25, 2022
There was a problem hiding this comment.
I think this is worth having!
I think we should add it to the other types we have that only implement `FromRequest:
BodyStreamRawBodyMultipartContentLengthLimit, note this one is conditional, only if what its wrapping implementsFromRequest. The docs should mention that.
- Added documentation snippet to BodyStream, RawBody, Multipart - Added documentation about the inner type of ContentLengthLimit - Fixed link type in State
|
All comments are addressed (I think!) |
davidpdrsn
reviewed
Aug 25, 2022
Co-authored-by: David Pedersen <david.pdrsn@gmail.com>
|
Well, CI failed :) will fix that later today. |
I need to check my editor config...
davidpdrsn
reviewed
Aug 25, 2022
Co-authored-by: David Pedersen <david.pdrsn@gmail.com>
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.
Added a note in the structs docs pointing to the relevant part of the documentation regarding extractor precedence.
Motivation
During discussion of a slightly unrelated problem (#1321), it was discovered that my example was ordering the extractors wrong, causing a compile-time problem.
Solution
This PR should hopefully make the solution for the above problem (reordering extractors) a little bit more discoverable.