Document scope limitations of concurrent Stream combinators #3676
+18
−3
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.
ConcurrentI've taken a stab at documenting the current behavior instead of trying to fix #3076 given how intractable fixing that bug has been.
I ran variations of this code with various combinators to see what the full scope of the problem is:
Unfortunately, scopes don't seem to propagate for basically any combinator requiring a
Concurrentinstance. More specifically, these are generally passing stream elements through channels to a concurrently running stream, and the scopes of the original stream aren't held open until the background stream completes.