-
Notifications
You must be signed in to change notification settings - Fork 200
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.
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
adds AsyncChannel and AsyncThrowingChannel with tests #2086
Changes from 2 commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,88 @@ | ||
// | ||
// Copyright Amazon.com Inc. or its affiliates. | ||
// All Rights Reserved. | ||
// | ||
// SPDX-License-Identifier: Apache-2.0 | ||
// | ||
|
||
import Foundation | ||
|
||
public actor AsyncChannel<Element: Sendable>: AsyncSequence { | ||
public struct Iterator: AsyncIteratorProtocol, Sendable { | ||
private let channel: AsyncChannel<Element> | ||
|
||
public init(_ channel: AsyncChannel<Element>) { | ||
self.channel = channel | ||
} | ||
|
||
public mutating func next() async -> Element? { | ||
await channel.next() | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Check for cancellation? https://developer.apple.com/documentation/swift/asynciteratorprotocol There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. What can be canceled here? |
||
} | ||
} | ||
|
||
public enum InternalFailure: Error { | ||
case cannotSendAfterTerminated | ||
} | ||
public typealias ChannelContinuation = CheckedContinuation<Element?, Never> | ||
|
||
private var continuations: [ChannelContinuation] = [] | ||
private var elements: [Element] = [] | ||
private var terminated: Bool = false | ||
|
||
private var hasNext: Bool { | ||
!continuations.isEmpty && !elements.isEmpty | ||
} | ||
|
||
private var canTerminate: Bool { | ||
terminated && elements.isEmpty && !continuations.isEmpty | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Should these be OR cases? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. this logic is correct |
||
} | ||
|
||
public init() { | ||
} | ||
|
||
public nonisolated func makeAsyncIterator() -> Iterator { | ||
Iterator(self) | ||
} | ||
|
||
public func next() async -> Element? { | ||
await withCheckedContinuation { (continuation: ChannelContinuation) in | ||
continuations.append(continuation) | ||
processNext() | ||
} | ||
} | ||
|
||
public func send(_ element: Element) throws { | ||
guard !terminated else { | ||
throw InternalFailure.cannotSendAfterTerminated | ||
} | ||
elements.append(element) | ||
processNext() | ||
} | ||
|
||
public func finish() { | ||
terminated = true | ||
processNext() | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. why are we calling processNext after finishing? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. see the |
||
} | ||
|
||
private func processNext() { | ||
if canTerminate { | ||
let continuation = continuations.removeFirst() | ||
assert(continuations.isEmpty) | ||
assert(elements.isEmpty) | ||
continuation.resume(returning: nil) | ||
return | ||
} | ||
|
||
guard hasNext else { | ||
return | ||
} | ||
|
||
assert(!continuations.isEmpty) | ||
assert(!elements.isEmpty) | ||
|
||
let continuation = continuations.removeFirst() | ||
let element = elements.removeFirst() | ||
|
||
continuation.resume(returning: element) | ||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,110 @@ | ||
// | ||
// Copyright Amazon.com Inc. or its affiliates. | ||
// All Rights Reserved. | ||
// | ||
// SPDX-License-Identifier: Apache-2.0 | ||
// | ||
|
||
import Foundation | ||
|
||
public actor AsyncThrowingChannel<Element: Sendable, Failure: Error>: AsyncSequence { | ||
public struct Iterator: AsyncIteratorProtocol, Sendable { | ||
private let channel: AsyncThrowingChannel<Element, Failure> | ||
|
||
public init(_ channel: AsyncThrowingChannel<Element, Failure>) { | ||
self.channel = channel | ||
} | ||
|
||
public mutating func next() async throws -> Element? { | ||
try await channel.next() | ||
} | ||
} | ||
|
||
public enum InternalFailure: Error { | ||
case cannotSendAfterTerminated | ||
} | ||
public typealias ChannelContinuation = CheckedContinuation<Element?, Error> | ||
|
||
private var continuations: [ChannelContinuation] = [] | ||
private var elements: [Element] = [] | ||
private var terminated: Bool = false | ||
private var error: Error? = nil | ||
|
||
private var hasNext: Bool { | ||
!continuations.isEmpty && !elements.isEmpty | ||
} | ||
|
||
private var canFail: Bool { | ||
error != nil && !continuations.isEmpty | ||
} | ||
|
||
private var canTerminate: Bool { | ||
terminated && elements.isEmpty && !continuations.isEmpty | ||
} | ||
|
||
public init() { | ||
} | ||
|
||
public nonisolated func makeAsyncIterator() -> Iterator { | ||
Iterator(self) | ||
} | ||
|
||
public func next() async throws -> Element? { | ||
try await withCheckedThrowingContinuation { (continuation: ChannelContinuation) in | ||
continuations.append(continuation) | ||
processNext() | ||
} | ||
} | ||
|
||
public func send(_ element: Element) throws { | ||
guard !terminated else { | ||
throw InternalFailure.cannotSendAfterTerminated | ||
} | ||
elements.append(element) | ||
processNext() | ||
} | ||
|
||
|
||
public func fail(_ error: Error) where Failure == Error { | ||
self.error = error | ||
processNext() | ||
} | ||
|
||
public func finish() { | ||
terminated = true | ||
processNext() | ||
} | ||
|
||
private func processNext() { | ||
if canFail { | ||
let continuation = continuations.removeFirst() | ||
assert(continuations.isEmpty) | ||
assert(elements.isEmpty) | ||
assert(error != nil) | ||
if let error = error { | ||
continuation.resume(throwing: error) | ||
return | ||
} | ||
} | ||
|
||
if canTerminate { | ||
let continuation = continuations.removeFirst() | ||
assert(continuations.isEmpty) | ||
assert(elements.isEmpty) | ||
continuation.resume(returning: nil) | ||
return | ||
} | ||
|
||
guard hasNext else { | ||
return | ||
} | ||
|
||
assert(!continuations.isEmpty) | ||
assert(!elements.isEmpty) | ||
|
||
let continuation = continuations.removeFirst() | ||
let element = elements.removeFirst() | ||
|
||
continuation.resume(returning: element) | ||
} | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we need
public
keyword for all these?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As discussed lets make these internal
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done, though the
AsyncSequence
is a protocol with associated type. There is no way to represent it in Swift for a return value without the implementation