Improve documentation about sharing state with handlers #3333
Conversation
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
yanns
approved these changes
Apr 30, 2025
mladedav
reviewed
Apr 30, 2025
Comment on lines
+344
to
+345
| //! smol does not yet offer equivalent functionality at the time of writing (see | ||
| //! [this GitHub issue](https://github.com/smol-rs/async-executor/issues/139)). |
There was a problem hiding this comment.
I'm late, but just to check, axum only supports tokio and can't really run under smol anyway, right? I haven't seen any plans to make it runtime-agnostiv either. Just checking if I'm missing something?
There was a problem hiding this comment.
No, actually. axum::serve uses tokio, but tokio is an optional dependency. There's smol-axum for an easy way of running an axum service on smol.
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.
I think task-local variables could have better docs. This is a start. We should minimize the example as well, but I feel like that we'll lose some information now. Maybe we need more complete examples for each of the state-sharing mechanisms, outside of the crate root docs. Anyways, this change should make sense regardless of any bigger doc improvements.