Recommend alternatives to SyncIoBridge #6795
Labels
A-tokio-util
Area: The tokio-util crate
C-bug
Category: This is a bug.
E-help-wanted
Call for participation: Help is requested to fix this issue.
M-io
Module: tokio/io
T-docs
Topic: documentation
Often when people try to use
SyncIoBridge
, there is a better alternative. We should improve the documentation to explain this and provide some alternatives. We should also provide an example of how to use it correctly withspawn_blocking
.As an example, if you wish to hash some data with
blake3
, then you should not do this:instead you should do this:
or this:
Here are some ways we can improve the documentation:
SyncIoBridge
to a non-async compression library)Vec<u8>
and usefrom_slice
instead of attempting to usefrom_reader
withSyncIoBridge
)std::fs
insidespawn_blocking
instead of combiningtokio::fs::File
withSyncIoBridge
. (seetokio::fs
module docs)SyncIoBridge
insidespawn_blocking
.tokio::io::copy
could use a note about this, since people often look here.Once we've added the examples to
SyncIoBridge
, we will probably copy them into a new topic page.This is a good first issue. Contact me for mentoring. I'm also open to other examples than the ones I mentioned; they're just my ideas. It is perfectly okay to submit a PR that only partially resolves this issue, e.g. by adding just one example.
The text was updated successfully, but these errors were encountered: