Skip to content

Add a combineLatestMany algorithm #360

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

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift Async Algorithms open source project
//
// Copyright (c) 2025 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
//
//===----------------------------------------------------------------------===//

#if compiler(>=6.2)

/// Creates an asynchronous sequence that combines the latest values from many `AsyncSequence` types
/// by emitting a tuple of the values. ``combineLatestMany(_:)`` only emits a value whenever any of the base `AsyncSequence`s
/// emit a value (so long as each of the bases have emitted at least one value).
///
/// Finishes:
/// ``combineLatestMany(_:)`` finishes when one of the bases finishes before emitting any value or
/// when all bases finished.
///
/// Throws:
/// ``combineLatestMany(_:)`` throws when one of the bases throws. If one of the bases threw any buffered and not yet consumed
/// values will be dropped.
@available(AsyncAlgorithms 1.1, *)
public func combineLatestMany<Element: Sendable, Failure: Error>(
_ bases: [any (AsyncSequence<Element, Failure> & Sendable)]
) -> some AsyncSequence<[Element], Failure> & Sendable {
AsyncCombineLatestManySequence<Element, Failure>(bases)
}

/// An `AsyncSequence` that combines the latest values produced from many asynchronous sequences into an asynchronous sequence of tuples.
@available(AsyncAlgorithms 1.1, *)
public struct AsyncCombineLatestManySequence<Element: Sendable, Failure: Error>: AsyncSequence, Sendable {
public typealias AsyncIterator = Iterator

typealias Base = AsyncSequence<Element, Failure> & Sendable
let bases: [any Base]

init(_ bases: [any Base]) {
self.bases = bases
}

public func makeAsyncIterator() -> AsyncIterator {
Iterator(
storage: .init(self.bases)
)
}

public struct Iterator: AsyncIteratorProtocol {
final class InternalClass {
private let storage: CombineLatestManyStorage<Element, Failure>

fileprivate init(storage: CombineLatestManyStorage<Element, Failure>) {
self.storage = storage
}

deinit {
self.storage.iteratorDeinitialized()
}

func next() async throws(Failure) -> [Element]? {
guard let element = try await self.storage.next() else {
return nil
}

// This force unwrap is safe since there must be a third element.
return element
}
}

let internalClass: InternalClass

fileprivate init(storage: CombineLatestManyStorage<Element, Failure>) {
self.internalClass = InternalClass(storage: storage)
}

public mutating func next() async throws(Failure) -> [Element]? {
try await self.internalClass.next()
}
}
}

@available(*, unavailable)
extension AsyncCombineLatestManySequence.Iterator: Sendable {}

#endif
Loading
Loading