Skip to content

docs: Clarify CPU-bound tasks on different pools, rather than not tokio #4105

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Sep 15, 2021
Merged

docs: Clarify CPU-bound tasks on different pools, rather than not tokio #4105

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1681b11
docs: Clarify CPU-bound tasks on different pools, rather than not tokio
alamb Sep 13, 2021
f061eb2
Attempt to clarify the separate executor should be used for CPU bound…
alamb Sep 13, 2021
45e0c5f
English nits
alamb Sep 13, 2021
c1e4489
Apply suggestions from code review
alamb Sep 15, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions tokio/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,9 +205,15 @@
//! ```
//!
//! If your code is CPU-bound and you wish to limit the number of threads used
//! to run it, you should run it on another thread pool such as [rayon]. You
//! can use an [`oneshot`] channel to send the result back to Tokio when the
//! rayon task finishes.
//! to run it, you should use a separate thread pool dedicated to CPU bound tasks
//! and *NOT* the same [`Runtime`] used to handle latency sensitive IO tasks.
//!
//! For example, you might consider using the [rayon] library or an
//! additional tokio [`Runtime`] instance other than the one used to handle
//! IO.
//!
//! Hint: If using rayon, you can use a [`oneshot`] channel to send the result back
//! to Tokio when the rayon task finishes.
//!
//! [rayon]: https://docs.rs/rayon
//! [`oneshot`]: crate::sync::oneshot
Expand Down