Add an async throwing source #1252
Merged
Conversation
This file contains hidden or 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
glbrntt
commented
Aug 27, 2021
| @@ -0,0 +1,59 @@ | |||
| /* | |||
There was a problem hiding this comment.
This was copied from #1245
|
cc @Davidde94 |
fabianfett
reviewed
Aug 27, 2021
Comment on lines
49
to
56
| /// Provide an element to the sequence. | ||
| /// | ||
| /// - Parameter element: The element to provide to the sequence. | ||
| /// - Returns: A `YieldResult` indicating whether the sequence accepted the element or not. | ||
| @discardableResult | ||
| internal func yield(_ element: Element) -> YieldResult { | ||
| return self.storage.yield(element) | ||
| } |
There was a problem hiding this comment.
Who would use the yield method?
There was a problem hiding this comment.
If this is called by a channel handler, this might become interesting with the generic element here.
fabianfett
reviewed
Aug 27, 2021
| fileprivate init(storage: AsyncThrowingSourceStorage<Element, Failure>) { | ||
| self.storage = storage | ||
| } | ||
|
|
There was a problem hiding this comment.
You are missing a deinit here, I'm afraid. If the consumer is not interested in your messages anymore, they might want to cancel the stream.
There was a problem hiding this comment.
The best way to achieve this, is to back the iterator by a class that references the storage.
fabianfett
reviewed
Aug 27, 2021
fabianfett
reviewed
Aug 27, 2021
Comment on lines
90
to
92
| internal func makeAsyncIterator() -> Iterator { | ||
| return Iterator(storage: self.storage) | ||
| } |
There was a problem hiding this comment.
what happens, if the consumer never calls makeAsyncIterator and the stream goes out of scope?
There was a problem hiding this comment.
Then any buffered elements would be dropped; but that's somewhat expected if they never call makeAsyncIterator? Feels like I'm missing your point here...
fabianfett
reviewed
Aug 27, 2021
| XCTAssertEqual(elements, 0) | ||
| } | ||
| } | ||
|
|
There was a problem hiding this comment.
add tests:
- user creates iterator but never consumes iterator
- user never creates iterator
There was a problem hiding this comment.
Can you elaborate? Not sure I understand what we would actually be asserting in each case.
Motivation: `AsyncThrowingStream` provides an implementation of `AsyncSequence` which allows the holder to provide new values to that sequence from within a closure provided to the initializer. This API doesn't fit our needs: we must be able to provide the values 'from the outside' rather than during initialization. Modifications: - Add an `AsyncThrowingSource`, an implementation of `AsyncSequence` which may have values provided to it via `yield(_:)` and terminated with `finish()` or `finish(throwing:)`. - Add tests and a few `AsyncSequence` helpers. Result: We have an `AsyncSequence` implementation which can have values provided to it.
glbrntt
force-pushed
the
gb-async-stream
branch
from
050f570 to
91661a4
Compare
fabianfett
reviewed
Aug 31, 2021
Comment on lines
128
to
132
| internal func consumeNextElement() async throws -> Element? { | ||
| return try await withCheckedThrowingContinuation { | ||
| self.consumeNextElement(continuation: $0) | ||
| } | ||
| } |
There was a problem hiding this comment.
I assume this should be @inlinable?
fabianfett
reviewed
Aug 31, 2021
Comment on lines
42
to
44
| internal func next() async throws -> Element? { | ||
| return try await self.storage.consumeNextElement() | ||
| } |
There was a problem hiding this comment.
Should this be @inlinable?
glbrntt
force-pushed
the
gb-async-stream
branch
from
5b636c4 to
eabd681
Compare
fabianfett
approved these changes
Sep 1, 2021
simonjbeaumont
pushed a commit
to simonjbeaumont/grpc-swift
that referenced
this pull request
Sep 3, 2021
Motivation: `AsyncThrowingStream` provides an implementation of `AsyncSequence` which allows the holder to provide new values to that sequence from within a closure provided to the initializer. This API doesn't fit our needs: we must be able to provide the values 'from the outside' rather than during initialization. Modifications: - Add a `PassthroughMessageSequence`, an implementation of `AsyncSequence` which consumes messages from a `PassthroughMessagesSource`. - The source may have values provided to it via `yield(_:)` and terminated with `finish()` or `finish(throwing:)`. - Add tests and a few `AsyncSequence` helpers. Result: We have an `AsyncSequence` implementation which can have values provided to it.
glbrntt
added a commit
to glbrntt/grpc-swift
that referenced
this pull request
Sep 16, 2021
Motivation: `AsyncThrowingStream` provides an implementation of `AsyncSequence` which allows the holder to provide new values to that sequence from within a closure provided to the initializer. This API doesn't fit our needs: we must be able to provide the values 'from the outside' rather than during initialization. Modifications: - Add a `PassthroughMessageSequence`, an implementation of `AsyncSequence` which consumes messages from a `PassthroughMessagesSource`. - The source may have values provided to it via `yield(_:)` and terminated with `finish()` or `finish(throwing:)`. - Add tests and a few `AsyncSequence` helpers. Result: We have an `AsyncSequence` implementation which can have values provided to it.
glbrntt
added a commit
to glbrntt/grpc-swift
that referenced
this pull request
Sep 16, 2021
Motivation: `AsyncThrowingStream` provides an implementation of `AsyncSequence` which allows the holder to provide new values to that sequence from within a closure provided to the initializer. This API doesn't fit our needs: we must be able to provide the values 'from the outside' rather than during initialization. Modifications: - Add a `PassthroughMessageSequence`, an implementation of `AsyncSequence` which consumes messages from a `PassthroughMessagesSource`. - The source may have values provided to it via `yield(_:)` and terminated with `finish()` or `finish(throwing:)`. - Add tests and a few `AsyncSequence` helpers. Result: We have an `AsyncSequence` implementation which can have values provided to it.
glbrntt
added a commit
that referenced
this pull request
Sep 16, 2021
Motivation: `AsyncThrowingStream` provides an implementation of `AsyncSequence` which allows the holder to provide new values to that sequence from within a closure provided to the initializer. This API doesn't fit our needs: we must be able to provide the values 'from the outside' rather than during initialization. Modifications: - Add a `PassthroughMessageSequence`, an implementation of `AsyncSequence` which consumes messages from a `PassthroughMessagesSource`. - The source may have values provided to it via `yield(_:)` and terminated with `finish()` or `finish(throwing:)`. - Add tests and a few `AsyncSequence` helpers. Result: We have an `AsyncSequence` implementation which can have values provided to it.
glbrntt
added a commit
that referenced
this pull request
Nov 26, 2021
Motivation: `AsyncThrowingStream` provides an implementation of `AsyncSequence` which allows the holder to provide new values to that sequence from within a closure provided to the initializer. This API doesn't fit our needs: we must be able to provide the values 'from the outside' rather than during initialization. Modifications: - Add a `PassthroughMessageSequence`, an implementation of `AsyncSequence` which consumes messages from a `PassthroughMessagesSource`. - The source may have values provided to it via `yield(_:)` and terminated with `finish()` or `finish(throwing:)`. - Add tests and a few `AsyncSequence` helpers. Result: We have an `AsyncSequence` implementation which can have values provided to it.
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.
Motivation:
AsyncThrowingStreamprovides an implementation ofAsyncSequencewhich allows the holder to provide new values to that sequence from
within a closure provided to the initializer. This API doesn't fit our
needs: we must be able to provide the values 'from the outside' rather
than during initialization.
Modifications:
AsyncThrowingSource, an implementation ofAsyncSequencewhich may have values provided to it via
yield(_:)and terminatedwith
finish()orfinish(throwing:).AsyncSequencehelpers.Result:
We have an
AsyncSequenceimplementation which can have values providedto it.