add more comments to chat example #1665
Merged
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
As discussed with Programatik and Ferry on Discord, people have lots of
questions about the chat example, so some more code comments might be
helpful.
Solution
As a new axum user myself (target audience of this example), I just tried to
express what I learned from carefully reading this example and implementing
something similar with slightly more words than before. A particular focus was
on the spawned tasks (hopefully useful for readers not too familiar with async
rust yet).