docs: add SyncIoBridge cross-references to copy functions#7798
Merged
ADD-SP merged 3 commits intotokio-rs:masterfrom Dec 29, 2025
Merged
docs: add SyncIoBridge cross-references to copy functions#7798ADD-SP merged 3 commits intotokio-rs:masterfrom
ADD-SP merged 3 commits intotokio-rs:masterfrom
Conversation
Add cross-reference notes to tokio::io::copy and tokio::io::copy_buf documentation pointing users to SyncIoBridge docs for guidance on async alternatives to using SyncIoBridge with synchronous consumers like hashers, compressors, and data parsers. This completes the remaining checklist item from tokio-rs#6795: 'Add links to the above in other relevant places' Closes tokio-rs#6795
ADD-SP
added
T-docs
ADD-SP
reviewed
Dec 29, 2025
Member
ADD-SP
left a comment
ADD-SP
left a comment
There was a problem hiding this comment.
Overall looks good to me, just a minor comment.
ADD-SP
added
the
S-waiting-on-author
Remove detailed examples list and extra links, keeping only a concise reference to SyncIoBridge documentation as suggested in review.
Contributor
Author
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
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.
Motivation
Issue #6795 requested improved documentation for
SyncIoBridgealternatives. While PR #6815 added comprehensive documentation toSyncIoBridgeitself, the final checklist item remained incomplete:Solution
Added cross-reference notes to
tokio::io::copyandtokio::io::copy_bufdocumentation, guiding users to theSyncIoBridgedocs for async alternatives when working with synchronous consumers (hashers, compressors, parsers).Closes #6795