docs: improve Read trait and ReadBufCursor documentation #4000
+101
−2
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
Add comprehensive documentation for implementing the Read trait: - Explain the difference from tokio's AsyncRead - Provide a complete example of implementing Read using put_slice - Document when to use unsafe methods Improve ReadBufCursor documentation: - Describe safe vs unsafe approaches - Add examples for both put_slice and as_mut/advance usage - Link to relevant methods Fixes hyperium#3649
seanmonstar
reviewed
Dec 17, 2025
Drop the sentence comparing with tokio's AsyncRead and io-uring, as suggested by maintainer. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <[email protected]>
Contributor
Author
|
Done, removed that sentence. Thanks for the review! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
Readtrait explaining how it differs from tokio'sAsyncReadReadon a custom struct usingput_sliceReadBufCursordocumentation with examples for both safe (put_slice) and unsafe (as_mut/advance) usage patternsMotivation
Users have reported confusion when trying to implement the
Readtrait, as the documentation was sparse and the relationship betweenReadBufCursormethods was unclear. The new documentation provides practical guidance with working examples.Fixes #3649
Test plan
cargo test --features full)