coop: expose coop as a public module
#7116
Open
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
github-actions
bot
added
R-loom-current-thread
maminrayej
force-pushed
the
feat/expose-coop
branch
from
274caa1 to
59eca5d
Compare
github-actions
bot
removed
R-loom-sync
Darksonn
reviewed
Jan 22, 2025
github-actions
bot
added
R-loom-current-thread
Darksonn
reviewed
Jan 23, 2025
Darksonn
reviewed
Jan 27, 2025
Co-authored-by: Alice Ryhl <[email protected]>
Darksonn
reviewed
Jan 28, 2025
Darksonn
reviewed
Jan 29, 2025
Comment on lines
+296
to
+301
| #[doc(hidden)] | ||
| #[deprecated = "Moved to tokio::task::coop::unconstrained"] | ||
| pub use coop::unconstrained; | ||
| #[doc(hidden)] | ||
| #[deprecated = "Moved to tokio::task::coop::Unconstrained"] | ||
| pub use coop::Unconstrained; |
There was a problem hiding this comment.
Can we move these next to consume_budget so they are grouped together?
Comment on lines
+172
to
+181
| /// Futures created by the tokio library functions are budget-aware and yield when there is no more | ||
| /// budget left, but not all futures will be budget-aware. Consider future `A` that polls two inner | ||
| /// futures `B` and `C`, and returns `Poll::Ready` when one of them is ready. If both inner futures | ||
| /// were budget-aware, at some point the budget would be depleted which would cause both futures to | ||
| /// return `Poll::Pending` resulting in `A` returning `Poll::Pending` as well. Yielding all the way | ||
| /// back to the runtime, the budget would be reset, and `B` and `C` could make progress again. | ||
| /// Now let's consider `B` is budget-aware, but `C` is not and is always ready. The budget will be | ||
| /// depleted as before, but now since `C` always returns `Poll::Ready`, `A` will always return | ||
| /// `Poll::Ready` as well. This way, `A` will not yield back to the runtime which will keep the budget | ||
| /// depleted and `B` not making progress. |
There was a problem hiding this comment.
This explanation is confusing. And more generally, this seems like a niche use-case. Are there not more common use-cases for this that we can explain instead?
E.g. maybe just have this example:
if !has_budget_remaining() {
tokio::task::yield_now().await;
}and say that this is similar to consume_budget, but doesn't decrement the budget when non-zero.
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.
This PR makes the
coopmodule public and exposes thehas_budget_remainingfunction.The motivation for this is to make
select!budget-aware (see #7108). The exposed functionality is also useful when dealing with a combination of budget-aware and non-budget-aware futures.Related to #7111.