Make AsyncStream Sync even if the inner future is not #115
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
The AsyncStream has a few methods that that take &self so we don't necessarily want to unconditionally impl Send for it. However, we only access the inner future by calling Future::poll. We can then make AsyncStream Send in a way that is more obviously safe by wrapping the inner stream in SyncWrapper from [0]. This gets the same effect (AsyncStream<T> is Sync) but uses only unsafe blocks that are more obviously safe. [0]: https://internals.rust-lang.org/t/what-shall-sync-mean-across-an-await/12020/2
|
I think the test failures are due to changes in rust 1.85 and not this PR (looks like |
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.
There's an old issue (#28) that asked for this and was closed because a
&selfmethod was added toAsyncStreamin #40. The issue has a pretty good description of why I would like this.However, if we copy the
SyncWrappertype from the internals thread mentioned in that issue then we can use it to wrap the future withinAsyncStreamand get the whole thing to implementSync.The tradeoff is that it is no longer possible to print the debug representation of the inner generator as that would require a shared reference to the future. I don't believe it is currently possible to create an
AsyncStreamthat actually implementsDebugusing the public API of the crate (as async blocks do not implementDebug) but I figure this is a trade-off worth bringing up. As a middle-ground it might be possible to use some hacks to only format the inner type when it implementsSync.