Add documentation for SyncIoBridge with examples and alternatives #6815
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
6 tasks
Darksonn
added
T-docs
tglane
reviewed
Sep 3, 2024
Nathy-bajo
force-pushed
the
sync-io-bridge-doc
branch
from
6673e3e to
30d38d5
Compare
tglane
reviewed
Sep 3, 2024
hawkw
requested changes
Sep 3, 2024
|
Hi @hawkw. |
Nathy-bajo
force-pushed
the
sync-io-bridge-doc
branch
from
cd8edbc to
6bdda28
Compare
Darksonn
reviewed
Sep 10, 2024
|
Hi @Darksonn |
tglane
reviewed
Jan 24, 2025
tglane
reviewed
Jan 26, 2025
Darksonn
reviewed
Jan 27, 2025
wngr
reviewed
Jan 27, 2025
Darksonn
reviewed
Jan 30, 2025
Comment on lines
7
to
8
| /// Use a [`tokio::io::AsyncRead`] synchronously as a [`std::io::Read`] or | ||
| /// a [`tokio::io::AsyncWrite`] as a [`std::io::Write`]. |
There was a problem hiding this comment.
I'm not sure why, but the links to AsyncRead and AsyncWrite are no longer working in the rendered documentation. Are you able to get them to work again.
Comment on lines
+56
to
+59
| /// // Hash the data using the blake3 hashing function. | ||
| /// let hash = blake3::hash(&data); | ||
| /// | ||
| /// Ok(()) |
There was a problem hiding this comment.
It makes more sense to actually return the hash from this function.
Suggested change
| /// // Hash the data using the blake3 hashing function. | |
| /// let hash = blake3::hash(&data); | |
| /// | |
| /// Ok(()) | |
| /// // Hash the data using the blake3 hashing function. | |
| /// let hash = blake3::hash(&data); | |
| /// | |
| /// Ok(hash) |
Comment on lines
+101
to
+104
| /// // Finalize the hash after all data has been processed. | ||
| /// let hash = hasher.finalize(); | ||
| /// | ||
| /// Ok(()) |
Comment on lines
+130
to
+134
| /// ```ignore | ||
| /// use async_compression::tokio::write::GzipEncoder; | ||
| /// use tokio::io::AsyncReadExt; | ||
| /// use tokio::io::Cursor; | ||
| /// use std::io::AsyncRead; |
There was a problem hiding this comment.
This example does not compile. I tried pasting it into the playground and got an error.
error[E0432]: unresolved import `tokio::io::Cursor`
--> src/main.rs:3:5
|
3 | use tokio::io::Cursor;
| ^^^^^^^^^^^^^^^^^ no `Cursor` in `io`
|
error[E0432]: unresolved import `std::io::AsyncRead`
--> src/main.rs:4:5
|
4 | use std::io::AsyncRead;
| ^^^^^^^^^^^^^^^^^^ no `AsyncRead` in `io`
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
The SyncIoBridge documentation lacked clarity on its usage, potentially leading to inefficient use and suboptimal performance. Users needed better guidance on when to use it and how to handle common use cases effectively.
Solution
This update enhances the SyncIoBridge documentation by:
These improvements aim to help users use SyncIoBridge more effectively and avoid common pitfalls.
Rendered