Use impl IntoResponse less in docs - #1049
Merged
Merged
Conversation
jplatte
approved these changes
May 22, 2022
bsodmike
reviewed
May 22, 2022
| /// // Note that returning `impl IntoResponse` might be easier if the response has many parts to | ||
| /// // it. The return type is written out here for clarity. | ||
| /// async fn handler() -> (SetHeader<'static>, SetHeader<'static>, &'static str) { | ||
| /// ( |
There was a problem hiding this comment.
@davidpdrsn doesn't the Impl IntoReponse interface recurse over the tuple essentially calling .into_reponse() on each tuple element? Referring to all_the_tuples!(impl_into_response); in the source of the trait.
davidpdrsn
added a commit
that referenced
this pull request
Jun 6, 2022
This file contains hidden or 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
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.
Previously we used
impl IntoResponsequite a lot in the docs to avoid having to write the full return type. However we've seen several cases on Discord and Twitter where people who are new to Rust gets confused about that. People sometimes thinks it allows returning different types along the lines ofWhich unfortunately wont work 😕 Writing out the full type should make the issue clear.
So I think we're actually doing people a disservice using
impl IntoResponseas much as we do. In general I think our docs should cater to beginners perhaps more than other crates, since web frameworks are likely to be the first big crate a newcomer picks up.So this changes the docs to spell out the return type where it is appropriate. I also added a section about calling
.into_response()to more easily return different types.