-
Notifications
You must be signed in to change notification settings - Fork 1.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add axum_extra::json!
#2962
Merged
Merged
Add axum_extra::json!
#2962
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
jplatte
reviewed
Oct 6, 2024
jplatte
reviewed
Oct 6, 2024
jplatte
approved these changes
Oct 6, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
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
Closes: #2937
Solution
Add
axum_extra::json!
, a macro that forwards totyped_json::json!
to produce an ad-hoc JSON response with zero allocations.I chose to put this in
axum-extra
rather than core Axum for two reasons:typed-json
. It’s a lightweight dependency and not exposed in the public API, but a dependency nonetheless.json!
to return anErasedJson
. UsingJson<impl Serialize>
isn’t ideal because if thejson!
macro borrows data, the type can’t be returned from a function. UsingResponse
directly isn’t ideal because we loseClone
.I had to modify a couple lines in the
Cargo.toml
ofaxum-extra
in order to get the tests to compile on my machine – just enabling some feature flags.