1 Commits

Author SHA1 Message Date
Sergej Jaskiewicz af0ae86407 WIP Publishers.Merge 2020-01-06 21:36:34 +03:00
241 changed files with 5238 additions and 25747 deletions
+274
View File
@@ -0,0 +1,274 @@
version: 2
jobs:
"Execute tests on macOS 10.15.0 (Xcode 11.3.0, Swift 5.1.3)":
macos:
xcode: "11.3.0"
environment:
SWIFT_VERSION: "5.1.3"
steps:
- checkout
- run:
name: Building and running tests in debug mode with coverage
command: |
make test-debug \
SWIFT_BUILD_FLAGS="-Xswiftc -warnings-as-errors" \
SWIFT_TEST_FLAGS="--enable-code-coverage --build-path .build-test-debug"
xcrun llvm-cov show \
-instr-profile=.build-test-debug/debug/codecov/default.profdata \
.build-test-debug/debug/OpenCombinePackageTests.xctest/Contents/MacOS/OpenCombinePackageTests \
> coverage.txt
- run:
name: Building and running tests in debug mode with TSan
command: |
make test-debug-sanitize-thread \
SWIFT_BUILD_FLAGS="-Xswiftc -warnings-as-errors" \
SWIFT_TEST_FLAGS="--build-path .build-test-debug-sanitize-thread"
- run:
name: Building and running tests in release mode
command: |
make test-release \
SWIFT_BUILD_FLAGS="-Xswiftc -warnings-as-errors" \
SWIFT_TEST_FLAGS="--build-path .build-test-release"
- run:
name: Generating Xcode project
command: make generate-xcodeproj SWIFT_BUILD_FLAGS="-Xswiftc -warnings-as-errors"
- run:
name: Building for testing on macOS 10.15.0 with xcodebuild
command: |
set -o pipefail \
&& xcodebuild build-for-testing \
-scheme OpenCombine-Package \
-sdk macosx10.15 \
-derivedDataPath DerivedData \
| tee xcodebuild_build-for-testing.log \
| xcpretty
- store_artifacts:
path: xcodebuild_build-for-testing.log
- run:
name: Testing on macOS 10.15.0 with xcodebuild
command: |
set -o pipefail \
&& xcodebuild test-without-building \
-scheme OpenCombine-Package \
-sdk macosx10.15 \
-derivedDataPath DerivedData \
| tee xcodebuild_test-without-building.log \
| xcpretty --report junit -o build/reports/results.xml
- store_artifacts:
path: xcodebuild_test-without-building.log
- store_test_results:
path: build/reports
- run:
name: Uploading code coverage
command: |
bash <(curl -s https://codecov.io/bash) -D DerivedData
"Execute compatibility tests on iOS 13.3 (Xcode 11.3.0, Swift 5.1.3)":
macos:
xcode: "11.3.0"
environment:
SWIFT_VERSION: "5.1.3"
steps:
- checkout
- run:
name: Generating Xcode project
command: make generate-compatibility-xcodeproj
- run:
name: Building for testing on iOS 13.3 with xcodebuild
command: |
set -o pipefail \
&& xcodebuild build-for-testing \
-scheme OpenCombine-Package \
-destination "platform=iOS Simulator,name=iPhone 11,OS=13.3" \
-derivedDataPath DerivedData \
| tee xcodebuild_build-for-testing.log \
| xcpretty
- store_artifacts:
path: xcodebuild_build-for-testing.log
- run:
name: Testing against Combine on iOS 13.3 with xcodebuild
command: |
set -o pipefail \
&& xcodebuild test-without-building \
-scheme OpenCombine-Package \
-destination "platform=iOS Simulator,name=iPhone 11,OS=13.3" \
-derivedDataPath DerivedData \
| tee xcodebuild_test-without-building.log \
| xcpretty --report junit -o build/reports/results.xml
- store_artifacts:
path: xcodebuild_test-without-building.log
- store_test_results:
path: build/reports
"Execute tests on iOS 9.3 (Xcode 10.2.1, Swift 5.0.1)":
macos:
xcode: "10.2.1"
environment:
BUNDLE_PATH: .bundle # path to install gems and use for caching
SWIFT_VERSION: "5.0.1"
steps:
- checkout
- run:
name: Installing gem dependencies
command: bundle install && bundle clean
- restore_cache:
keys:
- v1-simulator-cache-{{ arch }}
- run:
# CircleCI doesn't have an iOS 9 simulator, so we need to install it manually.
name: Installing iOS 9 simulator
command: |
bundle exec xcversion simulators --install="iOS 9.3"
bundle exec xcversion simulators
xcrun simctl list
- save_cache:
key: v1-simulator-cache-{{ arch }}
paths:
- ~/Library/Caches/XcodeInstall
- run:
name: Generating Xcode project
command: |
make generate-xcodeproj SWIFT_BUILD_FLAGS="-Xswiftc -warnings-as-errors"
xcodebuild -scheme OpenCombine-Package -showdestinations
- run:
name: Building for testing on iOS 9.3 with xcodebuild
command: |
set -o pipefail \
&& xcodebuild build-for-testing \
-scheme OpenCombine-Package \
-destination "platform=iOS Simulator,name=iPhone 4s,OS=9.3" \
-derivedDataPath DerivedData \
| tee xcodebuild_build-for-testing.log \
| xcpretty
- store_artifacts:
path: xcodebuild_build-for-testing.log
- run:
name: Testing on iOS 9.3 with xcodebuild
command: |
set -o pipefail \
&& xcodebuild test-without-building \
-scheme OpenCombine-Package \
-destination "platform=iOS Simulator,name=iPhone 4s,OS=9.3" \
-derivedDataPath DerivedData \
| tee xcodebuild_test-without-building.log \
| xcpretty --report junit -o build/reports/results.xml
- store_artifacts:
path: xcodebuild_test-without-building.log
- store_test_results:
path: build/reports
- run:
name: Uploading code coverage
command: |
bash <(curl -s https://codecov.io/bash) -D DerivedData
"Execute tests on Ubuntu 18.04 (Swift 5.1.1)":
docker:
- image: swift:5.1.1-bionic
environment:
SWIFT_VERSION: "5.1.1"
steps:
- checkout
- run:
name: Installing dependencies
command: |
apt update -y
apt upgrade -y
apt install -y curl
- run:
name: Building and running tests in debug mode with coverage
command: | # We need to run the test command twice because of https://bugs.swift.org/browse/SR-10783
make test-debug \
SWIFT_TEST_FLAGS="--enable-test-discovery \
--enable-index-store \
--enable-code-coverage \
--build-path .build-test-debug" \
> /dev/null 2>&1 \
|| true
make test-debug \
SWIFT_BUILD_FLAGS="-Xswiftc -warnings-as-errors" \
SWIFT_TEST_FLAGS="--enable-test-discovery \
--enable-index-store \
--enable-code-coverage \
--build-path .build-test-debug"
llvm-cov show \
-instr-profile=.build-test-debug/debug/codecov/default.profdata \
.build-test-debug/debug/OpenCombinePackageTests.xctest \
> coverage.txt
- run:
name: Building and running tests in debug mode with TSan
command: | # We need to run the test command twice because of https://bugs.swift.org/browse/SR-10783
make test-debug-sanitize-thread \
SWIFT_BUILD_FLAGS="-Xswiftc -warnings-as-errors" \
SWIFT_TEST_FLAGS="--enable-test-discovery \
--enable-index-store \
--build-path .build-test-debug-sanitize-thread" \
> /dev/null 2>&1 \
|| true
make test-debug-sanitize-thread \
SWIFT_TEST_FLAGS="--enable-test-discovery \
--enable-index-store \
--build-path .build-test-debug-sanitize-thread" \
- run:
name: Building and running tests in release mode
command: |
make test-release \
SWIFT_BUILD_FLAGS="-Xswiftc -warnings-as-errors" \
SWIFT_TEST_FLAGS="--enable-test-discovery \
--enable-index-store \
--build-path .build-test-release"
- run:
name: Uploading code coverage
command: |
bash <(curl -s https://codecov.io/bash)
"Run SwiftLint and Danger":
macos:
xcode: "11.3.0"
environment:
HOMEBREW_NO_AUTO_UPDATE: "1"
steps:
- checkout
- run:
name: Install SwiftLint
command: |
brew install swiftlint
- run:
name: Install danger-swift
command: |
brew install danger/tap/danger-swift
- run:
name: Run danger-swift
command: danger-swift ci
"Run Pod spec lint":
macos:
xcode: "11.3.0"
environment:
HOMEBREW_NO_AUTO_UPDATE: "1"
steps:
- checkout
- run:
name: Pod lib lint
command: |
pod lib lint --allow-warnings --verbose
workflows:
version: 2
"OpenCombine: execute tests on macOS":
jobs:
- "Execute tests on macOS 10.15.0 (Xcode 11.3.0, Swift 5.1.3)"
"OpenCombine: execute compatibility tests":
jobs:
- "Execute compatibility tests on iOS 13.3 (Xcode 11.3.0, Swift 5.1.3)"
"OpenCombine: execute tests on iOS":
jobs:
- "Execute tests on iOS 9.3 (Xcode 10.2.1, Swift 5.0.1)"
"OpenCombine: execute tests on Linux":
jobs:
- "Execute tests on Ubuntu 18.04 (Swift 5.1.1)"
"OpenCombine: run SwiftLint and Danger":
jobs:
- "Run SwiftLint and Danger"
"OpenCombine: validate podspec files":
jobs:
- "Run Pod spec lint"
-16
View File
@@ -1,16 +0,0 @@
name: CocoaPods
on:
push:
branches: [master]
pull_request:
branches: [master]
jobs:
validate_podspec:
name: Run pod lib lint
runs-on: macos-latest
steps:
- uses: actions/checkout@v2
- name: Run pod lib lint
run: pod lib lint --allow-warnings --verbose
-28
View File
@@ -1,28 +0,0 @@
name: Compatibility tests
on:
push:
branches: [master]
pull_request:
branches: [master]
schedule:
- cron: "0 9 * * 1" # Every Monday at 9:00 AM
jobs:
compatibility_tests_macos:
name: Execute compatibility tests
runs-on: macos-latest
steps:
- uses: actions/checkout@v2
- name: Run tests against Apple's Combine
# Attempt to run compatibility tests on macOS.
# If they fail, run on iOS.
run: |
make test-compatibility \
|| (set -o pipefail \
&& xcodebuild test \
-scheme OpenCombine-Package \
-destination "name=iPhone 13" \
-xcconfig Combine-Compatibility.xcconfig \
| tee xcodebuild_test.log \
| xcpretty)
-126
View File
@@ -1,126 +0,0 @@
name: macOS
on:
push:
branches: [master]
pull_request:
branches: [master]
jobs:
# This job is not a part of the macos_test job because of
# the 'This copy of libswiftCore.dylib requires an OS version prior to 10.14.4.' error.
# We have to invoke install_name_tool and patch the test executable
# to work around this error.
#
# Other combinations of Xcode and macOS versions don't lead to this error.
swift_5_0_test:
name: Execute tests (macos-10.15, 10.3)
runs-on: macos-10.15
steps:
- uses: actions/checkout@v2
- name: Setup Xcode
uses: maxim-lobanov/setup-xcode@v1
with:
xcode-version: "10.3"
- name: Swift version
run: swift --version
- name: Build and run tests in debug mode with coverage
run: |
swift build \
--build-tests \
-c debug \
-Xswiftc -warnings-as-errors \
-Xswiftc -profile-generate \
-Xswiftc -profile-coverage-mapping \
--build-path .build-test-debug
install_name_tool \
-rpath /Applications/Xcode_10.3.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/lib/swift/macosx /usr/lib/swift \
.build-test-debug/debug/OpenCombinePackageTests.xctest/Contents/MacOS/OpenCombinePackageTests
install_name_tool \
-add_rpath /Applications/Xcode_10.3.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/lib/swift/macosx \
.build-test-debug/debug/OpenCombinePackageTests.xctest/Contents/MacOS/OpenCombinePackageTests
swift test \
--skip-build \
--enable-code-coverage \
--build-path .build-test-debug
xcrun llvm-cov show \
-instr-profile=.build-test-debug/debug/codecov/default.profdata \
.build-test-debug/debug/OpenCombinePackageTests.xctest/Contents/MacOS/OpenCombinePackageTests \
> coverage.txt
- name: Build and run tests in release mode
run: |
swift build \
--build-tests \
-c release \
-Xswiftc -warnings-as-errors \
-Xswiftc -profile-generate \
-Xswiftc -profile-coverage-mapping \
--build-path .build-test-release
install_name_tool \
-rpath /Applications/Xcode_10.3.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/lib/swift/macosx /usr/lib/swift \
.build-test-release/release/OpenCombinePackageTests.xctest/Contents/MacOS/OpenCombinePackageTests
install_name_tool \
-add_rpath /Applications/Xcode_10.3.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/lib/swift/macosx \
.build-test-release/release/OpenCombinePackageTests.xctest/Contents/MacOS/OpenCombinePackageTests
swift test \
--skip-build \
-c release \
--enable-code-coverage \
--build-path .build-test-release
- uses: codecov/codecov-action@v2
with:
verbose: true
macos_test:
name: Execute tests
strategy:
fail-fast: false
matrix:
include:
- os: macos-10.15
xcode-version: "11.3.1" # Swift 5.3.1
- os: macos-10.15
xcode-version: "11.7" # Swift 5.2.4
- os: macos-11
xcode-version: "12.4" # Swift 5.3.2
- os: macos-11
xcode-version: "12.5.1" # Swift 5.4.2
- os: macos-11
xcode-version: "13.2.1" # Swift 5.5.2
runs-on: ${{ matrix.os }}
steps:
- uses: actions/checkout@v2
- name: Setup Xcode
uses: maxim-lobanov/setup-xcode@v1
with:
xcode-version: ${{ matrix.xcode-version }}
- name: Swift version
run: swift --version
- name: Build and run tests in debug mode with coverage
run: |
swift test \
-c debug \
-Xswiftc -warnings-as-errors \
--enable-code-coverage \
--build-path .build-test-debug
xcrun llvm-cov show \
-instr-profile=.build-test-debug/debug/codecov/default.profdata \
.build-test-debug/debug/OpenCombinePackageTests.xctest/Contents/MacOS/OpenCombinePackageTests \
> coverage.txt
- name: Build and run tests in debug mode with TSan
if: ${{ matrix.xcode-version != '13.2.1' }} # https://bugs.swift.org/browse/SR-15444
run: |
swift test \
-c debug \
--sanitize thread \
-Xswiftc -warnings-as-errors \
--build-path .build-test-debug-sanitize-thread
- name: Build and run tests in release mode
run: |
swift test \
-c release \
-Xswiftc -warnings-as-errors \
--enable-code-coverage \
--build-path .build-test-release
- uses: codecov/codecov-action@v2
with:
verbose: true
-26
View File
@@ -1,26 +0,0 @@
name: SwiftLint
on:
pull_request:
paths:
- ".github/workflows/swiftlint.yml"
- ".swiftlint.yml"
- "**/*.swift"
jobs:
SwiftLint:
runs-on: ubuntu-20.04
steps:
- uses: actions/checkout@v1
# Fetch current versions of files
- name: Fetch base ref
run: |
git fetch --prune --no-tags --depth=1 origin +refs/heads/${{ github.base_ref }}:refs/heads/${{ github.base_ref }}
# Diff pull request to current files, then SwiftLint changed files
- name: GitHub Action for SwiftLint
uses: mayk-it/action-swiftlint@3.2.2
env:
DIFF_BASE: ${{ github.base_ref }}
DIFF_HEAD: HEAD
with:
args: --strict
-57
View File
@@ -1,57 +0,0 @@
name: Ubuntu
on:
push:
branches: [master]
pull_request:
branches: [master]
jobs:
ubuntu_test:
name: Execute tests on Ubuntu
strategy:
fail-fast: false
matrix:
swift_version: ["5.0", "5.1", "5.2", "5.3", "5.4", "5.5"]
runs-on: ubuntu-latest
container: swift:${{ matrix.swift_version }}-bionic
steps:
- uses: actions/checkout@v2
- name: Generating LinuxMain.swift
if: >-
${{ matrix.swift_version == '5.0' ||
matrix.swift_version == '5.1' ||
matrix.swift_version == '5.2' ||
matrix.swift_version == '5.3' }}
run: |
apt update -y
apt upgrade -y
apt install -y python3.8
python3.8 utils/discover_tests.py
- name: Building and running tests in debug mode with coverage
run: |
swift test \
-c debug \
-Xswiftc -warnings-as-errors \
--enable-code-coverage \
--build-path .build-test-debug
llvm-cov show \
-instr-profile=.build-test-debug/debug/codecov/default.profdata \
.build-test-debug/debug/OpenCombinePackageTests.xctest \
> coverage.txt
- name: Building and running tests in debug mode with TSan
if: ${{ matrix.swift_version != '5.0' }} # There are false positives there
run: |
swift test \
-c debug \
--sanitize thread \
--build-path .build-test-debug-sanitize-thread
- name: Building and running tests in release mode
run: |
swift test \
-c release \
-Xswiftc -warnings-as-errors \
--build-path .build-test-release
- uses: codecov/codecov-action@v2
with:
verbose: true
-33
View File
@@ -1,33 +0,0 @@
name: Wasm
on:
push:
branches: [master]
pull_request:
branches: [master]
jobs:
carton_wasmer_test_5_3:
name: "Execute tests on Wasm (Swift 5.3)"
runs-on: ubuntu-20.04
steps:
- uses: actions/checkout@v2
- uses: swiftwasm/swiftwasm-action@v5.3
carton_wasmer_test_5_4:
name: "Execute tests on Wasm (Swift 5.4)"
runs-on: ubuntu-20.04
steps:
- uses: actions/checkout@v2
- uses: swiftwasm/swiftwasm-action@v5.4
carton_wasmer_test_5_5:
name: "Execute tests on Wasm (Swift 5.5)"
runs-on: ubuntu-20.04
steps:
- uses: actions/checkout@v2
- uses: swiftwasm/swiftwasm-action@v5.5
-21
View File
@@ -1,21 +0,0 @@
name: Windows
on:
push:
branches: [master]
pull_request:
branches: [master]
jobs:
windows_test:
name: Execute tests on Windows
strategy:
fail-fast: false
matrix:
swift_version: ["5.4.2", "5.5.1"]
runs-on: windows-2019
steps:
- uses: actions/checkout@v2
- uses: MaxDesiatov/swift-windows-action@v1
with:
swift-version: ${{ matrix.swift_version }}
-1
View File
@@ -3,7 +3,6 @@
/Packages
/*.xcodeproj
/.swiftpm
Tests/LinuxMain.swift
# Created by https://www.gitignore.io/api/Xcode
# Edit at https://www.gitignore.io/?templates=Xcode
-7
View File
@@ -2,8 +2,6 @@ included:
- Sources
- Tests
child_config: Tests/.swiftlint.yml
disabled_rules:
- block_based_kvo
- class_delegate_protocol
@@ -25,7 +23,6 @@ disabled_rules:
- trailing_comma
- type_body_length
- opening_brace
- untyped_error_in_catch
opt_in_rules:
- array_init
@@ -68,10 +65,6 @@ opt_in_rules:
- vertical_whitespace_closing_braces
- yoda_condition
implicit_return:
included:
- closure
line_length:
warning: 90
error: 120
-299
View File
@@ -1,299 +0,0 @@
# 0.12.0 (29 Jan 2021)
This release adds a new `OpenCombineShim` product that will conditionally re-export either
Combine on Apple platforms, or OpenCombine on other platforms. Additionally, `ObservableObject`
protocol is now available and working on all platforms.
A bug with `Timer(timeInterval:repeats:block:)` firing immediately not accounting for the passed
`timeInterval` is fixed.
**Merged pull requests:**
- Fix `Timer(timeInterval:repeats:block:)` not accounting `timeInterval` ([#196](https://github.com/OpenCombine/OpenCombine/pull/196)) via [@grigorye](https://github.com/grigorye)
- Add `OpenCombineShim` product for easier importing ([#197](https://github.com/OpenCombine/OpenCombine/pull/197)) via [@MaxDesiatov](https://github.com/MaxDesiatov)
- Implementation for `ObservableObject` with `Mirror` ([#201](https://github.com/OpenCombine/OpenCombine/pull/201)) via [@kateinoigakukun](https://github.com/kateinoigakukun)
# 0.11.0 (29 Oct 2020)
This release is compatible with Xcode 12.1.
### Additions
- `Publisher.assigned(to:)` method that accepts a `Published.Publisher`.
- New `Publisher.switchToLatest()` overloads.
- New `Publisher.flatMap(maxPublishers:_:)` overloads.
- `Optional.publisher` property.
- New `_Introspection` protocol that allows to track and explore the subscription graph and data flow.
### Bugfixes
- The project should now compile without warnings.
- The following entities have been updated to match the behavior of the newest Combine version:
- `Subscribers.Assign`
- `Publishers.Breakpoint`
- `Publishers.Buffer`
- `CombineIdentifier`
- `Publishers.CompactMap`
- `Publishers.Concatenate`
- `Publishers.Debounce`
- `Publishers.Delay`
- `DispatchQueue.SchedulerTimeType.Stride`
- `Publishers.Drop`
- `Publishers.Encode`
- `Publishers.Decode`
- `Publishers.Filter`
- `Publishers.HandleEvents`
- `Publishers.IgnoreOutput`
- `Publishers.MeasureInterval`
- `OperationQueue` scheduler
- `Published`
- `Publishers.ReceiveOn`
- `Publishers.ReplaceError`
- `RunLoop scheduler`
- `Publishers.Sequence`
- `Subscribers.Sink`
- `Publishers.SubscribeOn`
- `Publishers.Timeout`
- `Timer` publisher
### Known issues
- The default implementation of the `objectWillChange` requirement of the `ObservableObject` protocol is not available in Swift 5.1 and later.
# 0.10.2 (23 Oct 2020)
### Bugfixes
- Fixed a crash caused by recursive acquisition of a non-recursive lock in SubbjectSubscriber (#186, thanks @stuaustin for the bug report)
### Known issues
- The default implementation of the `objectWillChange` requirement of the `ObservableObject` protocol is not available in Swift 5.1 and later.
# 0.10.1 (4 Oct 2020)
### Bugfixes
- Fixed build errors on Linux with Swift 5.0 and Swift 5.3 toolchains (thanks, @adamleonard and @devmaximilian)
### Known issues
- The default implementation of the `objectWillChange` requirement of the `ObservableObject` protocol is not available in Swift 5.1 and later.
# 0.10.0 (28 Jun 2020)
This release is compatible with Xcode 11.5.
### Additions
- `Timer.publish(every:tolerance:on:in:options:)` (#156, thank you @MaxDesiatov)
- `OperationQueue` scheduler (#165)
- `Publishers.Timeout` (#164)
- `Publishers.Debounce` (#133)
### Bugfixes
- `PassthroughSubject`, `CurrentValueSubject` and `Future` have been rewritten from scratch. They are now faster, more correct and no longer leak subscriptions (#170).
### Known issues
- The default implementation of the `objectWillChange` requirement of the `ObservableObject` protocol is not available in Swift 5.1 and later.
# 0.9.0 (12 Jun 2020)
This release is compatible with Xcode 11.5.
### Additions
- The `Subscribers.Demand` struct can be nicely formatted in LLDB (#146, thank you @mayoff).
- `Publishers.SwitchToLatest` (#142).
- The `RunLoop` scheduler in `OpenCombineFoundation` (#131).
- `Publishers.Catch` and `Publishers.TryCatch` (#140).
### Bugfixes
- Worked around a [bug in the Swift compiler](https://bugs.swift.org/browse/SR-11680) when building the `COpenCombineHelpers` target (#145, thank you @mayoff).
- Improved documentation.
### Known issues
- The default implementation of the `objectWillChange` requirement of the `ObservableObject` protocol is not available in Swift 5.1 and later.
# 0.8.0 (17 Jan 2020)
This release is compatible with Xcode 11.3.1.
### Additions
- `Publishers.ReplaceEmpty` (#122, thank you @spadafiva)
- `NotificationCenter.Publisher` (#84)
- `URLSession.DataTaskPublisher` (#127)
- `Publishers.DropUntilOutput` (#136)
- `Publishers.CollectByCount` (#137)
- `Publishers.AssertNoFailure` (#138)
- `Publishers.Buffer` (#143)
### Bugfixes
- Fixed integer overflows in `DispatchQueue.SchedulerTimeType.Stride` (#126, #130)
- Fixed the 'default will never be executed' warning on non-Darwin platforms (like Linux) (#129)
### Known issues
- The default implementation of the `objectWillChange` requirement of the `ObservableObject` protocol is not available in Swift 5.1.
# 0.7.0 (10 Dec 2019)
This release is compatible with Xcode 11.2.1.
### Additions
- `Publishers.Delay` (#114)
- `Publishers.ReceiveOn` (#115)
- `Publishers.SubscribeOn` (#116)
- `Publishers.MeasureInterval` (#117)
- `Publishers.Breakpoint` (#118)
- `Publishers.HandleEvents` (#118)
- `Publishers.Concatenate` (#90)
### Known issues
- The default implementation of the `objectWillChange` requirement of the `ObservableObject` protocol is not available in Swift 5.1.
# 0.6.0 (26 Nov 2019)
This release is compatible with Xcode 11.2.1.
### Thread safety
- `Publishers.IgnoreOutput` has been audited for thread safety (#88)
- `Publishers.DropWhile` and `Publishers.TryDropWhile` have been audited for thread safety (#87)
### Additions
- `Publishers.Output` (#91)
- `Record` (#100)
- `Publishers.RemoveDuplicates`, `Publishers.TryRemoveDuplicates` (#89)
- `Publishers.PrefixWhile`, `Publishers.TryPrefixWhile` (#89)
- `Future` (#107, thanks @MaxDesiatov!)
### Bugfixes
- The behavior of the `Publishers.Encode` and `Publishers.Decode` subscriptions is fixed (#112)
- The behavior of the `Publishers.IgnoreOutput` subscription is fixed (#88)
- The behavior of the `Publishers.Print` subscription is fixed (#92)
- The behavior of the `Publishers.ReplaceError` subscription is fixed (#89)
- The behavior of the `Publishers.Filter` and `Publishers.TryFilter` subscriptions is fixed (#89)
- The behavior of the `Publishers.CompactMap` and `Publishers.TryCompactMap` subscriptions is fixed (#89)
- The behavior of the `Publishers.Multicast` subscription is fixed (#110)
- `Publishers.FlatMap` is reimplemented from scratch. Its behavior is fixed in many ways, it now fully matches that of Combine (#89)
- `@Published` property wrapper is fixed! (#112)
- The behavior of `DispatchQueue.SchedulerTimeType` is fixed to match that of the latest SDKs (#96)
- OpenCombine is now usable on 32 bit platforms. Why? Because we can.
### Known issues
- The default implementation of the `objectWillChange` requirement of the `ObservableObject` protocol is not available in Swift 5.1.
# 0.5.0 (17 Oct 2019)
This release is compatible with Xcode 11.1.
### Additions
- `Publishers.MapKeyPath` (#71)
- `Publishers.Reduce` (#76)
- `Publishers.TryReduce` (#76)
- `Publishers.Last` (#76)
- `Publishers.LastWhere` (#76)
- `Publishers.TryLastWhere` (#76)
- `Publishers.AllSatisfy` (#76)
- `Publishers.TryAllSatisfy` (#76)
- `Publishers.Contains` (#76)
- `Publishers.ContainsWhere` (#76)
- `Publishers.TryContainsWhere` (#76)
- `Publishers.Collect` (#76)
- `Publishers.Comparison` (#76)
- `Publishers.Drop` (#70, thank you @5sw!)
- `Publishers.Scan` (#83, thank you @epatey!)
- `Publishers.TryScan` (#83, thank you @epatey!)
### Bugfixes
- `Publishers.Print` doesn't print a redundant whitespace anymore.
### Known issues
- `@Published` property wrapper doesn't work yet
# 0.4.0 (8 Oct 2019)
This release is compatible with Xcode 11.1.
### Thread safety
- `SubjectSubscriber` (which is used when you subscribe a subject to a publisher) has been audited for thread-safety
- `Publishers.Multicast` has been audited for thread safety (#63)
- `Publishers.TryMap` has been audited for thread safety
- `Just` has been audited for thread safety
- `Optional.Publisher` has been audited for thread safety
- `Publishers.Sequence` has been audited for thread safety
- `Publishers.ReplaceError` has been audited for thread safety
- `Subscribers.Assign` has been audited for thread safety
- `Subscribers.Sink` has been audited for thread safety
### Bugfixes
- The semantics of `Publishers.Print`, `Publishers.TryMap` have been fixed
- Fix `iterator.next()` being called twice in `Publishers.Sequence` (#62)
- The default initializer of `CombineIdentifier` (the one that takes no arguments) is now much faster (#66, #69)
- When `Publishers.Sequence` subscription is cancelled while it emits values, the cancellation is respected (#73, thanks @5sw!)
### Additions
- `DispatchQueueScheduler` (#46)
- `Equatable` conformances for `First`, `ReplaceError`
- Added `eraseToAnyPublisher()` method (#59, thanks @evyasafhouzz for reporting!)
- `Publishers.MakeConnectable` (#61)
- `Publishers.Autoconnect` (#60)
- `Publishers.Share` (#60)
### Known issues
- `@Published` property wrapper doesn't work yet
# 0.3.0 (13 Sep 2019)
Among other things this release is compatible with Xcode 11.0 GM seed.
### Bugfixes
- Store newly send value in internal variable inside CurrentValueObject (#39, thanks @FranzBusch!)
### Additions
- `Filter`/`TryFilter` (#22, thanks @spadafiva!)
- `First`/`FirstWhere`/`TryFirstWhere` (#22, thanks again @spadafiva!)
- `CompactMap`/`TryCompacrMap` (#32)
- `IgnoreOutput` (#44, thanks @epatey!)
- `ReplaceError` (#50, thanks @vladiulianbogdan!)
- `FlatMap` (#45, thanks again @epatey!)
### Known issues
- `@Published` property wrapper doesn't work yet
# 0.2.0 (31 Jul 2019)
Updated for the newest Xcode 11.0 beta 5
# 0.1.0 (4 Jul 2019)
The first pre-pre-pre-alpha release is here!
Lots of stuff still unimplemented.
For now we have:
- `Just`
- `Publishers.Decode`
- `Publishers.DropWhile`
- `Publishers.Empty`
- `Publishers.Encode`
- `Publishers.Fail`
- `Publishers.Map`
- `Publishers.Multicast`
- `Publishers.Once`
- `Publishers.Optional`
- `Publishers.Print`
- `Publishers.Sequence`
- `Subscribers.Assign`
- `Subscribers.Completion`
- `Subscribers.Demand`
- `Subscribers.Sink`
- `AnyCancellable`
- `AnyPublisher`
- `AnySubject`
- `AnySubscriber`
- `Cancellable`
- `CombineIdentifier`
- `ConnectablePublisher`
- `CurrentValueSubject`
- `CustomCombineIdentifierConvertible`
- `ImmediateScheduler`
- `PassthroughSubject`
- `Publisher`
- `Result`
- `Scheduler`
- `Subject`
- `Subscriber`
- `Subscription`
+3 -3
View File
@@ -66,10 +66,10 @@ do {
}
}
SwiftLint.lint(.all(directory: nil),
inline: true,
SwiftLint.lint(inline: true,
configFile: ".swiftlint.yml",
strict: true)
strict: true,
lintAllFiles: true)
if danger.warnings.isEmpty, danger.fails.isEmpty {
markdown("LGTM")
+2 -2
View File
@@ -2,7 +2,7 @@ GEM
remote: https://rubygems.org/
specs:
CFPropertyList (3.0.1)
addressable (2.8.0)
addressable (2.7.0)
public_suffix (>= 2.0.2, < 5.0)
atomos (0.1.3)
babosa (1.0.3)
@@ -93,7 +93,7 @@ GEM
http-cookie (1.0.3)
domain_name (~> 0.5)
httpclient (2.8.3)
json (2.3.1)
json (2.2.0)
jwt (2.1.0)
memoist (0.16.1)
mime-types (3.3)
+4 -4
View File
@@ -1,17 +1,17 @@
Pod::Spec.new do |spec|
spec.name = "OpenCombine"
spec.version = "0.13.0"
spec.version = "0.7.0"
spec.summary = "Open source implementation of Apple's Combine framework for processing values over time."
spec.description = <<-DESC
An open source implementation of Apple's Combine framework for processing values over time.
DESC
spec.homepage = "https://github.com/OpenCombine/OpenCombine/"
spec.homepage = "https://github.com/broadwaylamb/OpenCombine/"
spec.license = "MIT"
spec.authors = { "Sergej Jaskiewicz" => "jaskiewiczs@icloud.com" }
spec.source = { :git => "https://github.com/OpenCombine/OpenCombine.git", :tag => "#{spec.version}" }
spec.source = { :git => "https://github.com/broadwaylamb/OpenCombine.git", :tag => "#{spec.version}" }
spec.swift_version = "5.0"
@@ -24,4 +24,4 @@ Pod::Spec.new do |spec|
spec.public_header_files = "Sources/COpenCombineHelpers/include/*.h"
spec.libraries = "c++"
end
end
+5 -5
View File
@@ -1,17 +1,17 @@
Pod::Spec.new do |spec|
spec.name = "OpenCombineDispatch"
spec.version = "0.13.0"
spec.version = "0.7.0"
spec.summary = "OpenCombine + Dispatch interoperability"
spec.description = <<-DESC
Extends `DispatchQueue` with conformance to the `Scheduler` protocol
DESC
spec.homepage = "https://github.com/OpenCombine/OpenCombine/"
spec.homepage = "https://github.com/broadwaylamb/OpenCombine/"
spec.license = "MIT"
spec.authors = { "Sergej Jaskiewicz" => "jaskiewiczs@icloud.com" }
spec.source = { :git => "https://github.com/OpenCombine/OpenCombine.git", :tag => "#{spec.version}" }
spec.source = { :git => "https://github.com/broadwaylamb/OpenCombine.git", :tag => "#{spec.version}" }
spec.swift_version = "5.0"
@@ -21,5 +21,5 @@ Pod::Spec.new do |spec|
spec.tvos.deployment_target = "9.0"
spec.source_files = "Sources/OpenCombineDispatch/**/*.swift"
spec.dependency "OpenCombine", '>= 0.12.0'
end
spec.dependency "OpenCombine", '>= 0.6'
end
+5 -5
View File
@@ -1,17 +1,17 @@
Pod::Spec.new do |spec|
spec.name = "OpenCombineFoundation"
spec.version = "0.13.0"
spec.version = "0.7.0"
spec.summary = "OpenCombine + OpenCombineFoundation interoperability"
spec.description = <<-DESC
Adds publishers to Foundation types like NotificationCenter, URLSession etc.
DESC
spec.homepage = "https://github.com/OpenCombine/OpenCombine/"
spec.homepage = "https://github.com/broadwaylamb/OpenCombine/"
spec.license = "MIT"
spec.authors = { "Sergej Jaskiewicz" => "jaskiewiczs@icloud.com" }
spec.source = { :git => "https://github.com/OpenCombine/OpenCombine.git", :tag => "#{spec.version}" }
spec.source = { :git => "https://github.com/broadwaylamb/OpenCombine.git", :tag => "#{spec.version}" }
spec.swift_version = "5.0"
@@ -21,5 +21,5 @@ Pod::Spec.new do |spec|
spec.tvos.deployment_target = "9.0"
spec.source_files = "Sources/OpenCombineFoundation/**/*.swift"
spec.dependency "OpenCombine", '>= 0.12.0'
end
spec.dependency "OpenCombine", '~> 0.6'
end
+10 -72
View File
@@ -1,87 +1,25 @@
// swift-tools-version:5.5
// swift-tools-version:5.0
import PackageDescription
// This list should be updated whenever SwiftPM adds support for a new platform.
// See: https://bugs.swift.org/browse/SR-13814
let supportedPlatforms: [Platform] = [
.macOS,
.macCatalyst,
.iOS,
.watchOS,
.tvOS,
.driverKit,
.linux,
.android,
.windows,
.wasi,
]
let package = Package(
name: "OpenCombine",
products: [
.library(name: "OpenCombine", targets: ["OpenCombine"]),
.library(name: "OpenCombineDispatch", targets: ["OpenCombineDispatch"]),
.library(name: "OpenCombineFoundation", targets: ["OpenCombineFoundation"]),
.library(name: "OpenCombineShim", targets: ["OpenCombineShim"]),
],
targets: [
.target(name: "COpenCombineHelpers"),
.target(
name: "OpenCombine",
dependencies: [
.target(name: "COpenCombineHelpers",
condition: .when(platforms: supportedPlatforms.except([.wasi])))
],
exclude: [
"Concurrency/Publisher+Concurrency.swift.gyb",
"Publishers/Publishers.Encode.swift.gyb",
"Publishers/Publishers.MapKeyPath.swift.gyb",
"Publishers/Publishers.Catch.swift.gyb"
],
swiftSettings: [.define("WASI", .when(platforms: [.wasi]))]
),
.target(name: "OpenCombine", dependencies: ["COpenCombineHelpers"]),
.target(name: "OpenCombineDispatch", dependencies: ["OpenCombine"]),
.target(
name: "OpenCombineFoundation",
dependencies: [
"OpenCombine",
.target(name: "COpenCombineHelpers",
condition: .when(platforms: supportedPlatforms.except([.wasi])))
]
),
.target(
name: "OpenCombineShim",
dependencies: [
"OpenCombine",
.target(name: "OpenCombineDispatch",
condition: .when(platforms: supportedPlatforms.except([.wasi]))),
.target(name: "OpenCombineFoundation",
condition: .when(platforms: supportedPlatforms.except([.wasi])))
]
),
.testTarget(
name: "OpenCombineTests",
dependencies: [
"OpenCombine",
.target(name: "OpenCombineDispatch",
condition: .when(platforms: supportedPlatforms.except([.wasi]))),
.target(name: "OpenCombineFoundation",
condition: .when(platforms: supportedPlatforms.except([.wasi]))),
],
swiftSettings: [
.unsafeFlags(["-enable-testing"]),
.define("WASI", .when(platforms: [.wasi]))
]
)
.target(name: "OpenCombineFoundation", dependencies: ["OpenCombine",
"COpenCombineHelpers"]),
.testTarget(name: "OpenCombineTests",
dependencies: ["OpenCombine",
"OpenCombineDispatch",
"OpenCombineFoundation"],
swiftSettings: [.unsafeFlags(["-enable-testing"])])
],
cxxLanguageStandard: .cxx17
cxxLanguageStandard: .cxx1z
)
// MARK: Helpers
extension Array where Element == Platform {
func except(_ exceptions: [Platform]) -> [Platform] {
return filter { !exceptions.contains($0) }
}
}
-34
View File
@@ -1,34 +0,0 @@
// swift-tools-version:5.0
import PackageDescription
let package = Package(
name: "OpenCombine",
products: [
.library(name: "OpenCombine", targets: ["OpenCombine"]),
.library(name: "OpenCombineDispatch", targets: ["OpenCombineDispatch"]),
.library(name: "OpenCombineFoundation", targets: ["OpenCombineFoundation"]),
.library(name: "OpenCombineShim", targets: ["OpenCombineShim"]),
],
targets: [
.target(name: "COpenCombineHelpers"),
.target(name: "OpenCombine", dependencies: ["COpenCombineHelpers"]),
.target(name: "OpenCombineDispatch", dependencies: ["OpenCombine"]),
.target(name: "OpenCombineFoundation", dependencies: ["OpenCombine",
"COpenCombineHelpers"]),
.target(
name: "OpenCombineShim",
dependencies: [
"OpenCombine",
"OpenCombineDispatch",
"OpenCombineFoundation",
]
),
.testTarget(name: "OpenCombineTests",
dependencies: ["OpenCombine",
"OpenCombineDispatch",
"OpenCombineFoundation"],
swiftSettings: [.unsafeFlags(["-enable-testing"])])
],
cxxLanguageStandard: .cxx1z
)
-34
View File
@@ -1,34 +0,0 @@
// swift-tools-version:5.1
import PackageDescription
let package = Package(
name: "OpenCombine",
products: [
.library(name: "OpenCombine", targets: ["OpenCombine"]),
.library(name: "OpenCombineDispatch", targets: ["OpenCombineDispatch"]),
.library(name: "OpenCombineFoundation", targets: ["OpenCombineFoundation"]),
.library(name: "OpenCombineShim", targets: ["OpenCombineShim"]),
],
targets: [
.target(name: "COpenCombineHelpers"),
.target(name: "OpenCombine", dependencies: ["COpenCombineHelpers"]),
.target(name: "OpenCombineDispatch", dependencies: ["OpenCombine"]),
.target(name: "OpenCombineFoundation", dependencies: ["OpenCombine",
"COpenCombineHelpers"]),
.target(
name: "OpenCombineShim",
dependencies: [
"OpenCombine",
"OpenCombineDispatch",
"OpenCombineFoundation",
]
),
.testTarget(name: "OpenCombineTests",
dependencies: ["OpenCombine",
"OpenCombineDispatch",
"OpenCombineFoundation"],
swiftSettings: [.unsafeFlags(["-enable-testing"])])
],
cxxLanguageStandard: .cxx1z
)
-34
View File
@@ -1,34 +0,0 @@
// swift-tools-version:5.2
import PackageDescription
let package = Package(
name: "OpenCombine",
products: [
.library(name: "OpenCombine", targets: ["OpenCombine"]),
.library(name: "OpenCombineDispatch", targets: ["OpenCombineDispatch"]),
.library(name: "OpenCombineFoundation", targets: ["OpenCombineFoundation"]),
.library(name: "OpenCombineShim", targets: ["OpenCombineShim"]),
],
targets: [
.target(name: "COpenCombineHelpers"),
.target(name: "OpenCombine", dependencies: ["COpenCombineHelpers"]),
.target(name: "OpenCombineDispatch", dependencies: ["OpenCombine"]),
.target(name: "OpenCombineFoundation", dependencies: ["OpenCombine",
"COpenCombineHelpers"]),
.target(
name: "OpenCombineShim",
dependencies: [
"OpenCombine",
"OpenCombineDispatch",
"OpenCombineFoundation",
]
),
.testTarget(name: "OpenCombineTests",
dependencies: ["OpenCombine",
"OpenCombineDispatch",
"OpenCombineFoundation"],
swiftSettings: [.unsafeFlags(["-enable-testing"])])
],
cxxLanguageStandard: .cxx1z
)
-90
View File
@@ -1,90 +0,0 @@
// swift-tools-version:5.3
import PackageDescription
// This list should be updated whenever SwiftPM adds support for a new platform.
// See: https://bugs.swift.org/browse/SR-13814
let supportedPlatforms: [Platform] = [
.macOS,
.iOS,
.watchOS,
.tvOS,
.linux,
.android,
// Disable Windows because of https://bugs.swift.org/browse/SR-13817
// .windows,
.wasi,
]
let package = Package(
name: "OpenCombine",
products: [
.library(name: "OpenCombine", targets: ["OpenCombine"]),
.library(name: "OpenCombineDispatch", targets: ["OpenCombineDispatch"]),
.library(name: "OpenCombineFoundation", targets: ["OpenCombineFoundation"]),
.library(name: "OpenCombineShim", targets: ["OpenCombineShim"]),
],
targets: [
.target(name: "COpenCombineHelpers"),
.target(
name: "OpenCombine",
dependencies: [
.target(name: "COpenCombineHelpers",
condition: .when(platforms: supportedPlatforms.except([.wasi])))
],
exclude: [
"Concurrency/Publisher+Concurrency.swift.gyb",
"Publishers/Publishers.Encode.swift.gyb",
"Publishers/Publishers.MapKeyPath.swift.gyb",
"Publishers/Publishers.Catch.swift.gyb"
],
swiftSettings: [.define("WASI", .when(platforms: [.wasi]))]
),
.target(name: "OpenCombineDispatch", dependencies: ["OpenCombine"]),
.target(
name: "OpenCombineFoundation",
dependencies: [
"OpenCombine",
.target(name: "COpenCombineHelpers",
condition: .when(platforms: supportedPlatforms.except([.wasi])))
]
),
.target(
name: "OpenCombineShim",
dependencies: [
"OpenCombine",
.target(name: "OpenCombineDispatch",
condition: .when(platforms: supportedPlatforms.except([.wasi]))),
.target(name: "OpenCombineFoundation",
condition: .when(platforms: supportedPlatforms.except([.wasi])))
]
),
.testTarget(
name: "OpenCombineTests",
dependencies: [
"OpenCombine",
.target(name: "OpenCombineDispatch",
condition: .when(platforms: supportedPlatforms.except([.wasi]))),
.target(name: "OpenCombineFoundation",
condition: .when(platforms: supportedPlatforms.except([.wasi]))),
],
swiftSettings: [
.unsafeFlags(["-enable-testing"]),
.define("WASI", .when(platforms: [.wasi]))
]
)
],
cxxLanguageStandard: .cxx1z
)
// MARK: Helpers
extension Array where Element == Platform {
func except(_ exceptions: [Platform]) -> [Platform] {
// See: https://bugs.swift.org/browse/SR-13813
let exceptionsDescriptions = exceptions.map(String.init(describing:))
return filter { platform in
!exceptionsDescriptions.contains(String(describing: platform))
}
}
}
-85
View File
@@ -1,85 +0,0 @@
// swift-tools-version:5.4
import PackageDescription
// This list should be updated whenever SwiftPM adds support for a new platform.
// See: https://bugs.swift.org/browse/SR-13814
let supportedPlatforms: [Platform] = [
.macOS,
.iOS,
.watchOS,
.tvOS,
.linux,
.android,
.windows,
.wasi,
]
let package = Package(
name: "OpenCombine",
products: [
.library(name: "OpenCombine", targets: ["OpenCombine"]),
.library(name: "OpenCombineDispatch", targets: ["OpenCombineDispatch"]),
.library(name: "OpenCombineFoundation", targets: ["OpenCombineFoundation"]),
.library(name: "OpenCombineShim", targets: ["OpenCombineShim"]),
],
targets: [
.target(name: "COpenCombineHelpers"),
.target(
name: "OpenCombine",
dependencies: [
.target(name: "COpenCombineHelpers",
condition: .when(platforms: supportedPlatforms.except([.wasi])))
],
exclude: [
"Concurrency/Publisher+Concurrency.swift.gyb",
"Publishers/Publishers.Encode.swift.gyb",
"Publishers/Publishers.MapKeyPath.swift.gyb",
"Publishers/Publishers.Catch.swift.gyb"
],
swiftSettings: [.define("WASI", .when(platforms: [.wasi]))]
),
.target(name: "OpenCombineDispatch", dependencies: ["OpenCombine"]),
.target(
name: "OpenCombineFoundation",
dependencies: [
"OpenCombine",
.target(name: "COpenCombineHelpers",
condition: .when(platforms: supportedPlatforms.except([.wasi])))
]
),
.target(
name: "OpenCombineShim",
dependencies: [
"OpenCombine",
.target(name: "OpenCombineDispatch",
condition: .when(platforms: supportedPlatforms.except([.wasi]))),
.target(name: "OpenCombineFoundation",
condition: .when(platforms: supportedPlatforms.except([.wasi])))
]
),
.testTarget(
name: "OpenCombineTests",
dependencies: [
"OpenCombine",
.target(name: "OpenCombineDispatch",
condition: .when(platforms: supportedPlatforms.except([.wasi]))),
.target(name: "OpenCombineFoundation",
condition: .when(platforms: supportedPlatforms.except([.wasi]))),
],
swiftSettings: [
.unsafeFlags(["-enable-testing"]),
.define("WASI", .when(platforms: [.wasi]))
]
)
],
cxxLanguageStandard: .cxx17
)
// MARK: Helpers
extension Array where Element == Platform {
func except(_ exceptions: [Platform]) -> [Platform] {
return filter { !exceptions.contains($0) }
}
}
+18 -71
View File
@@ -1,56 +1,39 @@
# OpenCombine
[![codecov](https://codecov.io/gh/OpenCombine/OpenCombine/branch/master/graph/badge.svg)](https://codecov.io/gh/OpenCombine/OpenCombine)
[![CircleCI](https://circleci.com/gh/broadwaylamb/OpenCombine/tree/master.svg?style=svg)](https://circleci.com/gh/broadwaylamb/OpenCombine/tree/master)
[![codecov](https://codecov.io/gh/broadwaylamb/OpenCombine/branch/master/graph/badge.svg)](https://codecov.io/gh/broadwaylamb/OpenCombine)
![Language](https://img.shields.io/badge/Swift-5.0-orange.svg)
![Platform](https://img.shields.io/badge/platform-Linux%20%7C%20macOS%20%7C%20iOS%20%7C%20watchOS%20%7C%20tvOS-lightgrey.svg)
![Cocoapods](https://img.shields.io/cocoapods/v/OpenCombine?color=blue)
[<img src="https://img.shields.io/badge/slack-OpenCombine-yellow.svg?logo=slack">](https://join.slack.com/t/opencombine/shared_invite/zt-96rr6cyf-0Hk5_hY8nM5zta6M56Jfzg)
[<img src="https://img.shields.io/badge/slack-OpenCombine-yellow.svg?logo=slack">](https://join.slack.com/t/opencombine/shared_invite/enQtNzE2MjE5NzkxODI0LTYxMjkzNDUxZWViZWI1Njc2YjBhODgxNjRjOTdkZTcxOGU2ZjJjZjYxMGI3NWZkN2RkNGFmZTUzNmU3MGE2ZWM)
Open-source implementation of Apple's [Combine](https://developer.apple.com/documentation/combine) framework for processing values over time.
The main goal of this project is to provide a compatible, reliable and efficient implementation which can be used on Apple's operating systems before macOS 10.15 and iOS 13, as well as Linux, Windows and WebAssembly.
| **CI Status** |
|---|
|[![Compatibility tests](https://github.com/OpenCombine/OpenCombine/actions/workflows/compatibility_tests.yml/badge.svg)](https://github.com/OpenCombine/OpenCombine/actions/workflows/compatibility_tests.yml)|
|[![macOS](https://github.com/OpenCombine/OpenCombine/actions/workflows/macos.yml/badge.svg)](https://github.com/OpenCombine/OpenCombine/actions/workflows/macos.yml)|
|[![Ubuntu](https://github.com/OpenCombine/OpenCombine/actions/workflows/ubuntu.yml/badge.svg)](https://github.com/OpenCombine/OpenCombine/actions/workflows/ubuntu.yml)|
|[![Windows](https://github.com/OpenCombine/OpenCombine/actions/workflows/windows.yml/badge.svg)](https://github.com/OpenCombine/OpenCombine/actions/workflows/windows.yml)|
|[![Wasm](https://github.com/OpenCombine/OpenCombine/actions/workflows/wasm.yml/badge.svg)](https://github.com/OpenCombine/OpenCombine/actions/workflows/wasm.yml)|
The main goal of this project is to provide a compatible, reliable and efficient implementation which can be used on Apple's operating systems before macOS 10.15 and iOS 13, as well as Linux and Windows.
The project is in early development.
### Installation
`OpenCombine` contains three public targets: `OpenCombine`, `OpenCombineFoundation` and `OpenCombineDispatch` (the fourth one, `COpenCombineHelpers`, is considered private. Don't import it in your projects).
`OpenCombine` contains two public targets: `OpenCombine` and `OpenCombineDispatch` (the third one, `COpenCombineHelpers`, is considered private. Don't import it in your projects).
OpenCombine itself does not have any dependencies. Not even Foundation or Dispatch. If you want to use OpenCombine with Dispatch (for example for using `DispatchQueue` as `Scheduler` for operators like `debounce`, `receive(on:)` etc.), you will need to import both `OpenCombine` and `OpenCombineDispatch`. The same applies to Foundation: if you want to use, for instance, `NotificationCenter` or `URLSession` publishers, you'll need to also import `OpenCombineFoundation`.
If you develop code for multiple platforms, you may find it more convenient to import the
`OpenCombineShim` module instead. It conditionally re-exports Combine on Apple platforms (if
available), and all OpenCombine modules on other platforms. You can import `OpenCombineShim` only
when using SwiftPM. It is not currently available for CocoaPods.
OpenCombine itself does not have any dependencies. Not even Foundation or Dispatch. If you want to use OpenCombine with Dispatch (for example for using `DispatchQueue` as `Scheduler` for operators like `debounce`, `receive(on:)` etc.), you will need to import both `OpenCombine` and `OpenCombineDispatch`.
##### Swift Package Manager
###### Swift Package
To add `OpenCombine` to your [SwiftPM](https://swift.org/package-manager/) package, add the `OpenCombine` package to the list of package and target dependencies in your `Package.swift` file. `OpenCombineDispatch` and `OpenCombineFoundation` products are currently not supported on WebAssembly. If your project targets WebAssembly exclusively, you should omit them from the list of your dependencies. If it targets multiple platforms including WebAssembly, depend on them only on non-WebAssembly platforms with [conditional target dependencies](https://github.com/apple/swift-evolution/blob/main/proposals/0273-swiftpm-conditional-target-dependencies.md).
To add `OpenCombine` to your [SPM](https://swift.org/package-manager/) package, add the `OpenCombine` package to the list of package and target dependencies in your `Package.swift` file.
```swift
dependencies: [
.package(url: "https://github.com/OpenCombine/OpenCombine.git", from: "0.13.0")
.package(url: "https://github.com/broadwaylamb/OpenCombine.git", from: "0.7.0")
],
targets: [
.target(
name: "MyAwesomePackage",
dependencies: [
"OpenCombine",
.product(name: "OpenCombineFoundation", package: "OpenCombine"),
.product(name: "OpenCombineDispatch", package: "OpenCombine")
]
),
.target(name: "MyAwesomePackage", dependencies: ["OpenCombine", "OpenCombineDispatch"])
]
```
###### Xcode
`OpenCombine` can also be added as a SwiftPM dependency directly in your Xcode project *(requires Xcode 11 upwards)*.
`OpenCombine` can also be added as a SPM dependency directly in your Xcode project *(requires Xcode 11 upwards)*.
To do so, open Xcode, use **File****Swift Packages****Add Package Dependency…**, enter the [repository URL](https://github.com/OpenCombine/OpenCombine.git), choose the latest available version, and activate the checkboxes:
To do so, open Xcode, use **File****Swift Packages****Add Package Dependency…**, enter the [repository URL](https://github.com/broadwaylamb/OpenCombine.git), choose the latest available version, and activate the checkboxes:
<p align="center">
<img alt="Select the OpenCombine and OpenCombineDispatch targets"
@@ -61,18 +44,17 @@ To do so, open Xcode, use **File** → **Swift Packages** → **Add Package Depe
To add `OpenCombine` to a project using [CocoaPods](https://cocoapods.org/), add `OpenCombine` and `OpenCombineDispatch` to the list of target dependencies in your `Podfile`.
```ruby
pod 'OpenCombine', '~> 0.13.0'
pod 'OpenCombineDispatch', '~> 0.13.0'
pod 'OpenCombineFoundation', '~> 0.13.0'
pod 'OpenCombine', '~> 0.7'
pod 'OpenCombineDispatch', '~> 0.7'
```
### Contributing
In order to work on this project you will need Xcode 10.2 and Swift 5.0 or later.
Please refer to the [issue #1](https://github.com/OpenCombine/OpenCombine/issues/1) for the list of operators that remain unimplemented, as well as the [RemainingCombineInterface.swift](https://github.com/OpenCombine/OpenCombine/blob/master/RemainingCombineInterface.swift) file. The latter contains the generated interface of Apple's Combine from the latest Xcode 11 version. When the functionality is implemented in OpenCombine, it should be removed from the RemainingCombineInterface.swift file.
Please refer to the [issue #1](https://github.com/broadwaylamb/OpenCombine/issues/1) for the list of operators that remain unimplemented, as well as the [RemainingCombineInterface.swift](https://github.com/broadwaylamb/OpenCombine/blob/master/RemainingCombineInterface.swift) file. The latter contains the generated interface of Apple's Combine from the latest Xcode 11 version. When the functionality is implemented in OpenCombine, it should be removed from the RemainingCombineInterface.swift file.
You can refer to [this repo](https://github.com/OpenCombine/combine-interfaces) to observe Apple's Combine API and documentation changes between different Xcode (beta) versions.
You can refer to [this gist](https://gist.github.com/broadwaylamb/c2c8550d76b3ff851c4c1dbf0a872e26) to observe Apple's Combine API changes between different Xcode (beta) versions, or to [this gist](https://gist.github.com/broadwaylamb/82dc2ce4ffbe06527c2c352b8f10910f) to see the relevant contents of the .swiftinterface file for Combine.
You can run compatibility tests against Apple's Combine. In order to do that you will need either macOS 10.14 with iOS 13 simulator installed (since the only way we can get Apple's Combine on macOS 10.14 is using the simulator), or macOS 10.15 (Apple's Combine is bundled with the OS). Execute the following command from the root of the package:
@@ -82,29 +64,7 @@ $ make test-compatibility
Or enable the `-DOPENCOMBINE_COMPATIBILITY_TEST` compiler flag in Xcode's build settings. Note that on iOS only the latter will work.
> NOTE: Before starting to work on some feature, please consult the [GitHub project](https://github.com/OpenCombine/OpenCombine/projects/2) to make sure that nobody's already making progress on the same feature! If not, then please create a draft PR to indicate that you're beginning your work.
#### Releasing a new version
1. Create a new branch from master and call it `release/<major>.<minor>.<patch>`.
1. Replace the usages of the old version in `README.md` with the new version (make sure to check the [Swift Package Manager](#swift-package-manager) and [CocoaPods](#cocoapods) sections).
1. Bump the version in `OpenCombine.podspec`, `OpenCombineDispatch.podspec` and `OpenCombineFoundation.podspec`. In the latter two you will also need to set the `spec.dependency "OpenCombine"` property to the **previous** version. Why? Because otherwise the `pod lib lint` command that we run on our regular CI will fail when validating the `OpenCombineDispatch` and `OpenCombineFoundation` podspecs, since the dependencies are not yet in the trunk. If we set the dependencies to the previous version (which is already in the trunk), everything will be fine. This is purely to make the CI work. The clients will not experience any issues, since the version is specified as `>=`.
1. Create a pull request to master for the release branch and make sure the CI passes.
1. Merge the pull request.
1. In the GitHub web interface on the [releases](https://github.com/OpenCombine/OpenCombine/releases) page, click the **Draft a new release** button.
1. The **Tag version** and **Release title** fields should be filled with the version number.
1. The description of the release should be consistent with the previous releases. It is a good practice to divide the description into several sections: additions, bugfixes, known issues etc. Also, be sure to mention the nicknames of the contributors of the new release.
1. Publish the release.
1. Switch to the master branch and pull the changes.
1. Push the release to CocoaPods trunk. For that, execute the following commands:
```
pod trunk push OpenCombine.podspec --verbose --allow-warnings
pod trunk push OpenCombineDispatch.podspec --verbose --allow-warnings
pod trunk push OpenCombineFoundation.podspec --verbose --allow-warnings
```
Note that you need to be one of the owners of the pod for that.
> NOTE: Before starting to work on some feature, please consult the [GitHub project](https://github.com/broadwaylamb/OpenCombine/projects/2) to make sure that nobody's already making progress on the same feature! If not, then please create a draft PR to indicate that you're beginning your work.
#### GYB
@@ -126,16 +86,3 @@ GYB template files have the `.gyb` extension. Run `make gyb` to generate Swift c
templates. The generated files are prefixed with `GENERATED-` and are checked into source control. Those
files should never be edited directly. Instead, the `.gyb` template should be edited, and after that the files
should be regenerated using `make gyb`.
#### Debugger Support
The file `opencombine_lldb.py` defines some `lldb` type summaries for easier debugging. These type summaries improve the way `lldb` and Xcode display some OpenCombine values.
To use `opencombine_lldb.py`, figure out its full path. Let's say the full path is `~/projects/OpenCombine/opencombine_lldb.py`. Then the following statement to your `~/.lldbinit` file:
command script import ~/projects/OpenCombine/opencombine_lldb.py
Currently, `opencombine_lldb.py` defines type summaries for these types:
- `Subscribers.Demand`
- That's all for now.
File diff suppressed because it is too large Load Diff
+124
View File
@@ -37,3 +37,127 @@ extension NSObject.KeyValueObservingPublisher : Combine.Publisher {
public func receive<S>(subscriber: S) where Value == S.Input, S : Combine.Subscriber, S.Failure == ObjectiveC.NSObject.KeyValueObservingPublisher<Subject, Value>.Failure
}
extension Timer {
public static func publish(every interval: Foundation.TimeInterval, tolerance: Foundation.TimeInterval? = nil, on runLoop: Foundation.RunLoop, in mode: Foundation.RunLoop.Mode, options: Foundation.RunLoop.SchedulerOptions? = nil) -> Foundation.Timer.TimerPublisher
final public class TimerPublisher : Combine.ConnectablePublisher {
public typealias Output = Foundation.Date
public typealias Failure = Swift.Never
final public let interval: Foundation.TimeInterval
final public let tolerance: Foundation.TimeInterval?
final public let runLoop: Foundation.RunLoop
final public let mode: Foundation.RunLoop.Mode
final public let options: Foundation.RunLoop.SchedulerOptions?
public init(interval: Foundation.TimeInterval, tolerance: Foundation.TimeInterval? = nil, runLoop: Foundation.RunLoop, mode: Foundation.RunLoop.Mode, options: Foundation.RunLoop.SchedulerOptions? = nil)
final public func receive<S>(subscriber: S) where S : Combine.Subscriber, S.Failure == Foundation.Timer.TimerPublisher.Failure, S.Input == Foundation.Timer.TimerPublisher.Output
final public func connect() -> Combine.Cancellable
@objc deinit
}
}
extension OperationQueue : Combine.Scheduler {
public struct SchedulerTimeType : Swift.Strideable, Swift.Codable, Swift.Hashable {
public var date: Foundation.Date
public init(_ date: Foundation.Date)
public func distance(to other: Foundation.OperationQueue.SchedulerTimeType) -> Foundation.OperationQueue.SchedulerTimeType.Stride
public func advanced(by n: Foundation.OperationQueue.SchedulerTimeType.Stride) -> Foundation.OperationQueue.SchedulerTimeType
public struct Stride : Swift.ExpressibleByFloatLiteral, Swift.Comparable, Swift.SignedNumeric, Swift.Codable, Combine.SchedulerTimeIntervalConvertible {
public typealias FloatLiteralType = Foundation.TimeInterval
public typealias IntegerLiteralType = Foundation.TimeInterval
public typealias Magnitude = Foundation.TimeInterval
public var magnitude: Foundation.TimeInterval
public var timeInterval: Foundation.TimeInterval {
get
}
public init(integerLiteral value: Foundation.TimeInterval)
public init(floatLiteral value: Foundation.TimeInterval)
public init(_ timeInterval: Foundation.TimeInterval)
public init?<T>(exactly source: T) where T : Swift.BinaryInteger
public static func < (lhs: Foundation.OperationQueue.SchedulerTimeType.Stride, rhs: Foundation.OperationQueue.SchedulerTimeType.Stride) -> Swift.Bool
public static func * (lhs: Foundation.OperationQueue.SchedulerTimeType.Stride, rhs: Foundation.OperationQueue.SchedulerTimeType.Stride) -> Foundation.OperationQueue.SchedulerTimeType.Stride
public static func + (lhs: Foundation.OperationQueue.SchedulerTimeType.Stride, rhs: Foundation.OperationQueue.SchedulerTimeType.Stride) -> Foundation.OperationQueue.SchedulerTimeType.Stride
public static func - (lhs: Foundation.OperationQueue.SchedulerTimeType.Stride, rhs: Foundation.OperationQueue.SchedulerTimeType.Stride) -> Foundation.OperationQueue.SchedulerTimeType.Stride
public static func *= (lhs: inout Foundation.OperationQueue.SchedulerTimeType.Stride, rhs: Foundation.OperationQueue.SchedulerTimeType.Stride)
public static func += (lhs: inout Foundation.OperationQueue.SchedulerTimeType.Stride, rhs: Foundation.OperationQueue.SchedulerTimeType.Stride)
public static func -= (lhs: inout Foundation.OperationQueue.SchedulerTimeType.Stride, rhs: Foundation.OperationQueue.SchedulerTimeType.Stride)
public static func seconds(_ s: Swift.Int) -> Foundation.OperationQueue.SchedulerTimeType.Stride
public static func seconds(_ s: Swift.Double) -> Foundation.OperationQueue.SchedulerTimeType.Stride
public static func milliseconds(_ ms: Swift.Int) -> Foundation.OperationQueue.SchedulerTimeType.Stride
public static func microseconds(_ us: Swift.Int) -> Foundation.OperationQueue.SchedulerTimeType.Stride
public static func nanoseconds(_ ns: Swift.Int) -> Foundation.OperationQueue.SchedulerTimeType.Stride
public init(from decoder: Swift.Decoder) throws
public func encode(to encoder: Swift.Encoder) throws
public static func == (a: Foundation.OperationQueue.SchedulerTimeType.Stride, b: Foundation.OperationQueue.SchedulerTimeType.Stride) -> Swift.Bool
}
public init(from decoder: Swift.Decoder) throws
public func encode(to encoder: Swift.Encoder) throws
public var hashValue: Swift.Int {
get
}
public func hash(into hasher: inout Swift.Hasher)
}
public struct SchedulerOptions {
}
public func schedule(options: Foundation.OperationQueue.SchedulerOptions?, _ action: @escaping () -> Swift.Void)
public func schedule(after date: Foundation.OperationQueue.SchedulerTimeType, tolerance: Foundation.OperationQueue.SchedulerTimeType.Stride, options: Foundation.OperationQueue.SchedulerOptions?, _ action: @escaping () -> Swift.Void)
public func schedule(after date: Foundation.OperationQueue.SchedulerTimeType, interval: Foundation.OperationQueue.SchedulerTimeType.Stride, tolerance: Foundation.OperationQueue.SchedulerTimeType.Stride, options: Foundation.OperationQueue.SchedulerOptions?, _ action: @escaping () -> Swift.Void) -> Combine.Cancellable
public var now: Foundation.OperationQueue.SchedulerTimeType {
get
}
public var minimumTolerance: Foundation.OperationQueue.SchedulerTimeType.Stride {
get
}
}
extension RunLoop : Combine.Scheduler {
public struct SchedulerTimeType : Swift.Strideable, Swift.Codable, Swift.Hashable {
public var date: Foundation.Date
public init(_ date: Foundation.Date)
public func distance(to other: Foundation.RunLoop.SchedulerTimeType) -> Foundation.RunLoop.SchedulerTimeType.Stride
public func advanced(by n: Foundation.RunLoop.SchedulerTimeType.Stride) -> Foundation.RunLoop.SchedulerTimeType
public struct Stride : Swift.ExpressibleByFloatLiteral, Swift.Comparable, Swift.SignedNumeric, Swift.Codable, Combine.SchedulerTimeIntervalConvertible {
public typealias FloatLiteralType = Foundation.TimeInterval
public typealias IntegerLiteralType = Foundation.TimeInterval
public typealias Magnitude = Foundation.TimeInterval
public var magnitude: Foundation.TimeInterval
public var timeInterval: Foundation.TimeInterval {
get
}
public init(integerLiteral value: Foundation.TimeInterval)
public init(floatLiteral value: Foundation.TimeInterval)
public init(_ timeInterval: Foundation.TimeInterval)
public init?<T>(exactly source: T) where T : Swift.BinaryInteger
public static func < (lhs: Foundation.RunLoop.SchedulerTimeType.Stride, rhs: Foundation.RunLoop.SchedulerTimeType.Stride) -> Swift.Bool
public static func * (lhs: Foundation.RunLoop.SchedulerTimeType.Stride, rhs: Foundation.RunLoop.SchedulerTimeType.Stride) -> Foundation.RunLoop.SchedulerTimeType.Stride
public static func + (lhs: Foundation.RunLoop.SchedulerTimeType.Stride, rhs: Foundation.RunLoop.SchedulerTimeType.Stride) -> Foundation.RunLoop.SchedulerTimeType.Stride
public static func - (lhs: Foundation.RunLoop.SchedulerTimeType.Stride, rhs: Foundation.RunLoop.SchedulerTimeType.Stride) -> Foundation.RunLoop.SchedulerTimeType.Stride
public static func *= (lhs: inout Foundation.RunLoop.SchedulerTimeType.Stride, rhs: Foundation.RunLoop.SchedulerTimeType.Stride)
public static func += (lhs: inout Foundation.RunLoop.SchedulerTimeType.Stride, rhs: Foundation.RunLoop.SchedulerTimeType.Stride)
public static func -= (lhs: inout Foundation.RunLoop.SchedulerTimeType.Stride, rhs: Foundation.RunLoop.SchedulerTimeType.Stride)
public static func seconds(_ s: Swift.Int) -> Foundation.RunLoop.SchedulerTimeType.Stride
public static func seconds(_ s: Swift.Double) -> Foundation.RunLoop.SchedulerTimeType.Stride
public static func milliseconds(_ ms: Swift.Int) -> Foundation.RunLoop.SchedulerTimeType.Stride
public static func microseconds(_ us: Swift.Int) -> Foundation.RunLoop.SchedulerTimeType.Stride
public static func nanoseconds(_ ns: Swift.Int) -> Foundation.RunLoop.SchedulerTimeType.Stride
public init(from decoder: Swift.Decoder) throws
public func encode(to encoder: Swift.Encoder) throws
public static func == (a: Foundation.RunLoop.SchedulerTimeType.Stride, b: Foundation.RunLoop.SchedulerTimeType.Stride) -> Swift.Bool
}
public init(from decoder: Swift.Decoder) throws
public func encode(to encoder: Swift.Encoder) throws
public var hashValue: Swift.Int {
get
}
public func hash(into hasher: inout Swift.Hasher)
}
public struct SchedulerOptions {
}
public func schedule(options: Foundation.RunLoop.SchedulerOptions?, _ action: @escaping () -> Swift.Void)
public func schedule(after date: Foundation.RunLoop.SchedulerTimeType, tolerance: Foundation.RunLoop.SchedulerTimeType.Stride, options: Foundation.RunLoop.SchedulerOptions?, _ action: @escaping () -> Swift.Void)
public func schedule(after date: Foundation.RunLoop.SchedulerTimeType, interval: Foundation.RunLoop.SchedulerTimeType.Stride, tolerance: Foundation.RunLoop.SchedulerTimeType.Stride, options: Foundation.RunLoop.SchedulerOptions?, _ action: @escaping () -> Swift.Void) -> Combine.Cancellable
public var now: Foundation.RunLoop.SchedulerTimeType {
get
}
public var minimumTolerance: Foundation.RunLoop.SchedulerTimeType.Stride {
get
}
}
@@ -10,31 +10,12 @@
#include <atomic>
#include <cstdlib>
#include <system_error>
#if __has_include(<pthread.h>)
# include <pthread.h>
# define OPENCOMBINE_HAS_PTHREAD 1
#else
# define OPENCOMBINE_HAS_PTHREAD 0
#endif
#if __has_include(<signal.h>)
# include <signal.h>
# define OPENCOMBINE_HAS_SIGNAL_HANDLING 1
#else
# define OPENCOMBINE_HAS_SIGNAL_HANDLING 0
#endif
#ifdef _WIN32
# include <windows.h>
#endif
#include <pthread.h>
#ifdef __APPLE__
#include <os/lock.h>
#endif // __APPLE__
#include <mutex>
// Throwing exceptions through language boundaries is undefined behavior,
// so we must catch all of them in our extern "C" functions.
#define OPENCOMBINE_HANDLE_EXCEPTION_BEGIN try {
@@ -65,11 +46,10 @@ public:
virtual void unlock() = 0;
virtual void assertOwner() {}
virtual ~PlatformIndependentMutex() {}
virtual ~PlatformIndependentMutex() noexcept(false) {}
};
#if OPENCOMBINE_HAS_PTHREAD
class PThreadMutex final : PlatformIndependentMutex {
class PThreadMutex : PlatformIndependentMutex {
private:
pthread_mutex_t mutex_;
public:
@@ -85,16 +65,20 @@ public:
PThreadMutex(PThreadMutex&&) = delete;
PThreadMutex& operator=(PThreadMutex&&) = delete;
void lock() override {
void lock() override final {
OPENCOMBINE_HANDLE_PTHREAD_CALL(pthread_mutex_lock(&mutex_));
}
void unlock() override {
void unlock() override final {
OPENCOMBINE_HANDLE_PTHREAD_CALL(pthread_mutex_unlock(&mutex_));
}
~PThreadMutex() {
pthread_mutex_destroy(&mutex_);
// Yep, this destructor may throw. This is deliberate, since pthread_mutex_destroy
// may fail.
//
// The altrenative is to just silently ignore the error, which is even worse.
OPENCOMBINE_HANDLE_PTHREAD_CALL(pthread_mutex_destroy(&mutex_));
}
protected:
class Attributes {
@@ -122,8 +106,12 @@ protected:
setType(PTHREAD_MUTEX_ERRORCHECK);
}
~Attributes() {
pthread_mutexattr_destroy(&attrs_);
~Attributes() noexcept(false) {
// Yep, this destructor may throw. This is deliberate,
// since pthread_mutexattr_destroy may fail.
//
// The altrenative is to just silently ignore the error, which is even worse.
OPENCOMBINE_HANDLE_PTHREAD_CALL(pthread_mutexattr_destroy(&attrs_));
}
private:
void setType(int type) {
@@ -135,7 +123,21 @@ protected:
OPENCOMBINE_HANDLE_PTHREAD_CALL(pthread_mutex_init(&mutex_, attributes.raw()));
}
};
#endif // OPENCOMBINE_HAS_PTHREAD
class PThreadRecursiveMutex final : PThreadMutex {
public:
PThreadRecursiveMutex() {
Attributes attrs;
attrs.setRecursive();
initialize(attrs);
}
PThreadRecursiveMutex(const PThreadRecursiveMutex&) = delete;
PThreadRecursiveMutex& operator=(const PThreadRecursiveMutex&) = delete;
PThreadRecursiveMutex(PThreadRecursiveMutex&&) = delete;
PThreadRecursiveMutex& operator=(PThreadRecursiveMutex&&) = delete;
};
#ifdef __APPLE__
@@ -164,60 +166,34 @@ public:
};
#endif // __APPLE__
template <typename Mu>
class GenericMutex final : PlatformIndependentMutex {
Mu mutex_;
public:
GenericMutex() = default;
GenericMutex(const GenericMutex&) = delete;
GenericMutex& operator=(const GenericMutex&) = delete;
GenericMutex(GenericMutex&&) = delete;
GenericMutex& operator=(GenericMutex&&) = delete;
void lock() override {
mutex_.lock();
}
void unlock() override {
mutex_.unlock();
}
};
using StdMutex = GenericMutex<std::mutex>;
using StdRecursiveMutex = GenericMutex<std::recursive_mutex>;
} // end anonymous namespace
extern "C" {
uint64_t opencombine_next_combine_identifier(void) {
return next_combine_identifier.fetch_add(1);
}
OpenCombineUnfairLock opencombine_unfair_lock_alloc(void) {
OPENCOMBINE_HANDLE_EXCEPTION_BEGIN
#ifdef __APPLE__
if (__builtin_available(macOS 10.12, iOS 10.0, tvOS 10.0, watchOS 3.0, *)) {
return {new OSUnfairLock};
} else {
return {new PThreadMutex};
}
#elif OPENCOMBINE_HAS_PTHREAD
// When possible, use pthread mutex implementation, because it allows
// setting the PTHREAD_MUTEX_ERRORCHECK attribute, which makes
// recursive locking a hard error instead of UB.
return {new PThreadMutex};
#else
return {new StdMutex};
return {new PThreadMutex};
#endif
OPENCOMBINE_HANDLE_EXCEPTION_END
}
OpenCombineUnfairRecursiveLock opencombine_unfair_recursive_lock_alloc(void) {
OPENCOMBINE_HANDLE_EXCEPTION_BEGIN
// TODO: Use os_unfair_recursive_lock on Darwin as soon as it becomes public API.
return {new StdRecursiveMutex};
return {new PThreadRecursiveMutex};
OPENCOMBINE_HANDLE_EXCEPTION_END
}
@@ -259,10 +235,4 @@ void opencombine_unfair_recursive_lock_dealloc(OpenCombineUnfairRecursiveLock lo
return delete static_cast<PlatformIndependentMutex*>(lock.opaque);
}
void opencombine_stop_in_debugger(void) {
#if _WIN32
DebugBreak();
#elif OPENCOMBINE_HAS_SIGNAL_HANDLING
raise(SIGTRAP);
#endif
}
} // extern "C"
@@ -9,6 +9,7 @@
#define COPENCOMBINEHELPERS_H
#include <stdint.h>
#include <signal.h>
#if __has_attribute(swift_name)
# define OPENCOMBINE_SWIFT_NAME(_name) __attribute__((swift_name(#_name)))
@@ -16,6 +17,12 @@
# define OPENCOMBINE_SWIFT_NAME(_name)
#endif
#if __has_attribute(always_inline)
# define OPENCOMBINE_ALWAYS_INLINE __attribute__((always_inline))
#else
# define OPENCOMBINE_ALWAYS_INLINE
#endif
#ifdef __cplusplus
extern "C" {
#endif
@@ -70,7 +77,12 @@ void opencombine_unfair_recursive_lock_dealloc(OpenCombineUnfairRecursiveLock lo
#pragma mark - Breakpoint
void opencombine_stop_in_debugger(void) OPENCOMBINE_SWIFT_NAME(__stopInDebugger());
OPENCOMBINE_ALWAYS_INLINE
inline void opencombine_stop_in_debugger(void) OPENCOMBINE_SWIFT_NAME(__stopInDebugger());
void opencombine_stop_in_debugger(void) {
raise(SIGTRAP);
}
#ifdef __cplusplus
} // extern "C"
+7 -8
View File
@@ -10,8 +10,7 @@
/// Subscriber implementations can use this type to provide a cancellation token that
/// makes it possible for a caller to cancel a publisher, but not to use the
/// `Subscription` object to request items.
///
/// An `AnyCancellable` instance automatically calls `cancel()` when deinitialized.
/// An AnyCancellable instance automatically calls `cancel()` when deinitialized.
public final class AnyCancellable: Cancellable, Hashable {
private var _cancel: (() -> Void)?
@@ -47,18 +46,18 @@ public final class AnyCancellable: Cancellable, Hashable {
extension AnyCancellable {
/// Stores this type-erasing cancellable instance in the specified collection.
///
/// - Parameter collection: The collection in which to store this `AnyCancellable`.
/// Stores this AnyCancellable in the specified collection.
/// Parameters:
/// - collection: The collection to store this AnyCancellable.
public func store<Cancellables: RangeReplaceableCollection>(
in collection: inout Cancellables
) where Cancellables.Element == AnyCancellable {
collection.append(self)
}
/// Stores this type-erasing cancellable instance in the specified collection.
///
/// - Parameter collection: The collection in which to store this `AnyCancellable`.
/// Stores this AnyCancellable in the specified set.
/// Parameters:
/// - collection: The set to store this AnyCancellable.
public func store(in set: inout Set<AnyCancellable>) {
set.insert(self)
}
+7 -53
View File
@@ -9,44 +9,8 @@ extension Publisher {
/// Wraps this publisher with a type eraser.
///
/// Use `eraseToAnyPublisher()` to expose an instance of `AnyPublisher`` to
/// Use `eraseToAnyPublisher()` to expose an instance of `AnyPublisher` to
/// the downstream subscriber, rather than this publishers actual type.
/// This form of _type erasure_ preserves abstraction across API boundaries, such as
/// different modules.
/// When you expose your publishers as the `AnyPublisher` type, you can change
/// the underlying implementation over time without affecting existing clients.
///
/// The following example shows two types that each have a `publisher` property.
/// `TypeWithSubject` exposes this property as its actual type, `PassthroughSubject`,
/// while `TypeWithErasedSubject` uses `eraseToAnyPublisher()` to expose it as
/// an `AnyPublisher`. As seen in the output, a caller from another module can access
/// `TypeWithSubject.publisher` as its native type. This means you cant change your
/// publisher to a different type without breaking the caller. By comparison,
/// `TypeWithErasedSubject.publisher` appears to callers as an `AnyPublisher`, so you
/// can change the underlying publisher type at will.
///
/// public class TypeWithSubject {
/// public let publisher: some Publisher = PassthroughSubject<Int,Never>()
/// }
/// public class TypeWithErasedSubject {
/// public let publisher: some Publisher = PassthroughSubject<Int,Never>()
/// .eraseToAnyPublisher()
/// }
///
/// // In another module:
/// let nonErased = TypeWithSubject()
/// if let subject = nonErased.publisher as? PassthroughSubject<Int,Never> {
/// print("Successfully cast nonErased.publisher.")
/// }
/// let erased = TypeWithErasedSubject()
/// if let subject = erased.publisher as? PassthroughSubject<Int,Never> {
/// print("Successfully cast erased.publisher.")
/// }
///
/// // Prints "Successfully cast nonErased.publisher."
///
/// - Returns: An ``AnyPublisher`` wrapping this publisher.
@inlinable
public func eraseToAnyPublisher() -> AnyPublisher<Output, Failure> {
return .init(self)
}
@@ -55,13 +19,7 @@ extension Publisher {
/// A type-erasing publisher.
///
/// Use `AnyPublisher` to wrap a publisher whose type has details you dont want to expose
/// across API boundaries, such as different modules. Wrapping a `Subject` with
/// `AnyPublisher` also prevents callers from accessing its `send(_:)` method. When you
/// use type erasure this way, you can change the underlying publisher implementation over
/// time without affecting existing clients.
///
/// You can use OpenCombines `eraseToAnyPublisher()` operator to wrap a publisher with
/// `AnyPublisher`.
/// to subscribers or other publishers.
public struct AnyPublisher<Output, Failure: Error>
: CustomStringConvertible,
CustomPlaygroundDisplayConvertible
@@ -71,17 +29,13 @@ public struct AnyPublisher<Output, Failure: Error>
/// Creates a type-erasing publisher to wrap the provided publisher.
///
/// - Parameter publisher: A publisher to wrap with a type-eraser.
/// - Parameters:
/// - publisher: A publisher to wrap with a type-eraser.
@inlinable
public init<PublisherType: Publisher>(_ publisher: PublisherType)
where Output == PublisherType.Output, Failure == PublisherType.Failure
{
// If this has already been boxed, avoid boxing again
if let erased = publisher as? AnyPublisher<Output, Failure> {
box = erased.box
} else {
box = PublisherBox(base: publisher)
}
box = PublisherBox(base: publisher)
}
public var description: String {
@@ -106,7 +60,7 @@ extension AnyPublisher: Publisher {
public func receive<Downstream: Subscriber>(subscriber: Downstream)
where Output == Downstream.Input, Failure == Downstream.Failure
{
box.receive(subscriber: subscriber)
box.subscribe(subscriber)
}
}
@@ -143,6 +97,6 @@ internal final class PublisherBox<PublisherType: Publisher>
override internal func receive<Downstream: Subscriber>(subscriber: Downstream)
where Failure == Downstream.Failure, Output == Downstream.Input
{
base.receive(subscriber: subscriber)
base.subscribe(subscriber)
}
}
+5 -11
View File
@@ -7,10 +7,9 @@
/// A type-erasing subscriber.
///
/// Use an `AnySubscriber` to wrap an existing subscriber whose details you dont want to
/// expose. You can also use `AnySubscriber` to create a custom subscriber by providing
/// closures for the methods defined in `Subscriber`, rather than implementing
/// `Subscriber` directly.
/// Use an `AnySubscriber` to wrap an existing subscriber whose details you dont want
/// to expose. You can also use `AnySubscriber` to create a custom subscriber by providing
/// closures for `Subscriber`s methods, rather than implementing `Subscriber` directly.
public struct AnySubscriber<Input, Failure: Error>: Subscriber,
CustomStringConvertible,
CustomReflectable,
@@ -45,11 +44,6 @@ public struct AnySubscriber<Input, Failure: Error>: Subscriber,
public init<Subscriber: OpenCombine.Subscriber>(_ subscriber: Subscriber)
where Input == Subscriber.Input, Failure == Subscriber.Failure
{
if let erased = subscriber as? AnySubscriber<Input, Failure> {
self = erased
return
}
combineIdentifier = subscriber.combineIdentifier
box = AnySubscriberBox(subscriber)
@@ -68,8 +62,8 @@ public struct AnySubscriber<Input, Failure: Error>: Subscriber,
if let playgroundDescription = subscriber as? CustomPlaygroundDisplayConvertible {
playgroundDescriptionThunk = { playgroundDescription.playgroundDescription }
} else if let description = subscriber as? CustomStringConvertible {
playgroundDescriptionThunk = { description.description }
} else if let desccription = subscriber as? CustomStringConvertible {
playgroundDescriptionThunk = { desccription.description }
} else {
let fixedDescription = String(describing: type(of: subscriber))
playgroundDescriptionThunk = { fixedDescription }
+7 -7
View File
@@ -5,7 +5,7 @@
// Created by Sergej Jaskiewicz on 10.06.2019.
//
/// A protocol indicating that an activity or action supports cancellation.
/// A protocol indicating that an activity or action may be canceled.
///
/// Calling `cancel()` frees up any allocated resources. It also stops side effects such
/// as timers, network access, or disk I/O.
@@ -17,18 +17,18 @@ public protocol Cancellable {
extension Cancellable {
/// Stores this cancellable instance in the specified collection.
///
/// - Parameter collection: The collection in which to store this `Cancellable`.
/// Stores this Cancellable in the specified collection.
/// Parameters:
/// - collection: The collection to store this Cancellable.
public func store<Cancellables: RangeReplaceableCollection>(
in collection: inout Cancellables
) where Cancellables.Element == AnyCancellable {
AnyCancellable(self).store(in: &collection)
}
/// Stores this cancellable instance in the specified set.
///
/// - Parameter set: The set in which to store this `Cancellable`.
/// Stores this Cancellable in the specified set.
/// Parameters:
/// - collection: The set to store this Cancellable.
public func store(in set: inout Set<AnyCancellable>) {
AnyCancellable(self).store(in: &set)
}
-8
View File
@@ -5,25 +5,17 @@
// Created by Sergej Jaskiewicz on 11.06.2019.
//
/// A type that defines methods for decoding.
public protocol TopLevelDecoder {
/// The type this decoder accepts.
associatedtype Input
/// Decodes an instance of the indicated type.
func decode<DecodablyType: Decodable>(_ type: DecodablyType.Type,
from: Input) throws -> DecodablyType
}
/// A type that defines methods for encoding.
public protocol TopLevelEncoder {
/// The type this encoder produces.
associatedtype Output
/// Encodes an instance of the indicated type.
///
/// - Parameter value: The instance to encode.
func encode<EncodableType: Encodable>(_ value: EncodableType) throws -> Output
}
+4 -22
View File
@@ -9,37 +9,19 @@
import COpenCombineHelpers
#endif
#if WASI
private var __identifier: UInt64 = 0
internal func __nextCombineIdentifier() -> UInt64 {
defer { __identifier += 1 }
return __identifier
}
#endif // WASI
/// A unique identifier for identifying publisher streams.
///
/// To conform to `CustomCombineIdentifierConvertible` in a
/// `Subscription` or `Subject` that you implement as a structure, create an instance of
/// `CombineIdentifier` as follows:
///
/// let combineIdentifier = CombineIdentifier()
public struct CombineIdentifier: Hashable, CustomStringConvertible {
private let rawValue: UInt64
private let value: UInt64
/// Creates a unique Combine identifier.
public init() {
rawValue = __nextCombineIdentifier()
value = __nextCombineIdentifier()
}
/// Creates a Combine identifier, using the bit pattern of the provided object.
public init(_ obj: AnyObject) {
rawValue = UInt64(UInt(bitPattern: ObjectIdentifier(obj)))
value = UInt64(UInt(bitPattern: ObjectIdentifier(obj)))
}
public var description: String {
return "0x\(String(rawValue, radix: 16))"
return "0x\(String(value, radix: 16))"
}
}
@@ -1,125 +0,0 @@
//
// Future+Concurrency.swift
//
//
// Created by Sergej Jaskiewicz on 28.08.2021.
//
#if canImport(_Concurrency) && compiler(>=5.5)
import _Concurrency
#endif
#if canImport(_Concurrency) && compiler(>=5.5) || compiler(>=5.5.1)
extension Future where Failure == Never {
@available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
public var value: Output {
get async {
await ContinuationSubscriber.withUnsafeSubscription(self)
}
}
}
extension Future {
@available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
public var value: Output {
get async throws {
try await ContinuationSubscriber.withUnsafeThrowingSubscription(self)
}
}
}
@available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
private final class ContinuationSubscriber<Input,
UpstreamFailure: Error,
ErrorOrNever: Error>
: Subscriber
{
typealias Failure = UpstreamFailure
private var continuation: UnsafeContinuation<Input, ErrorOrNever>?
private var subscription: Subscription?
private let lock = UnfairLock.allocate()
private init(_ continuation: UnsafeContinuation<Input, ErrorOrNever>) {
self.continuation = continuation
}
deinit {
lock.deallocate()
}
func receive(subscription: Subscription) {
lock.lock()
guard self.subscription == nil else {
assertionFailure("Unexpected state: received subscription twice")
lock.unlock()
subscription.cancel()
return
}
self.subscription = subscription
lock.unlock()
subscription.request(.max(1))
}
func receive(_ input: Input) -> Subscribers.Demand {
lock.lock()
if let continuation = self.continuation.take() {
lock.unlock()
continuation.resume(returning: input)
} else {
assertionFailure("Unexpected state: already completed")
lock.unlock()
}
return .none
}
func receive(completion: Subscribers.Completion<Failure>) {
lock.lock()
subscription = nil
lock.unlock()
completion.failure.map(handleFailure)
}
private func handleFailure(_ error: Failure) {
lock.lock()
if let continuation = self.continuation.take() {
lock.unlock()
continuation.resume(throwing: error as! ErrorOrNever)
} else {
assertionFailure("Unexpected state: already completed")
lock.unlock()
}
}
}
@available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
extension ContinuationSubscriber where ErrorOrNever == Error {
fileprivate static func withUnsafeThrowingSubscription<Upstream: Publisher>(
_ upstream: Upstream
) async throws -> Input
where Upstream.Output == Input,
Upstream.Failure == UpstreamFailure
{
try await withUnsafeThrowingContinuation { continuation in
upstream.subscribe(ContinuationSubscriber(continuation))
}
}
}
@available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
extension ContinuationSubscriber where UpstreamFailure == Never, ErrorOrNever == Never {
fileprivate static func withUnsafeSubscription<Upstream: Publisher>(
_ upstream: Upstream
) async -> Input
where Upstream.Output == Input,
Upstream.Failure == Never
{
await withUnsafeContinuation { continuation in
upstream.subscribe(ContinuationSubscriber(continuation))
}
}
}
#endif
@@ -1,331 +0,0 @@
//
//
// Auto-generated from GYB template. DO NOT EDIT!
//
//
//
//
// Publisher+Concurrency.swift
//
//
// Created by Sergej Jaskiewicz on 28.08.2021.
//
#if canImport(_Concurrency) && compiler(>=5.5)
import _Concurrency
#endif
#if canImport(_Concurrency) && compiler(>=5.5) || compiler(>=5.5.1)
extension Publisher where Failure == Never {
@available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
public var values: AsyncPublisher<Self> {
return .init(self)
}
}
@available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
public struct AsyncPublisher<Upstream: Publisher>: AsyncSequence
where Upstream.Failure == Never
{
public typealias Element = Upstream.Output
public struct Iterator: AsyncIteratorProtocol {
public typealias Element = Upstream.Output
fileprivate let inner: Inner
public mutating func next() async -> Element? {
return await withTaskCancellationHandler(
handler: { [inner] in inner.cancel() },
operation: { [inner] in await inner.next() }
)
}
}
public typealias AsyncIterator = Iterator
private let publisher: Upstream
public init(_ publisher: Upstream) {
self.publisher = publisher
}
public func makeAsyncIterator() -> Iterator {
let inner = Iterator.Inner()
publisher.subscribe(inner)
return Iterator(inner: inner)
}
}
@available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
extension AsyncPublisher.Iterator {
fileprivate final class Inner: Subscriber, Cancellable {
typealias Input = Upstream.Output
typealias Failure = Upstream.Failure
private enum State {
case awaitingSubscription
case subscribed(Subscription)
case terminal
}
private let lock = UnfairLock.allocate()
private var pending: [UnsafeContinuation<Input?, Never>] = []
private var state = State.awaitingSubscription
private var pendingDemand = Subscribers.Demand.none
deinit {
lock.deallocate()
}
func receive(subscription: Subscription) {
lock.lock()
guard case .awaitingSubscription = state else {
lock.unlock()
subscription.cancel()
return
}
state = .subscribed(subscription)
let pendingDemand = self.pendingDemand
self.pendingDemand = .none
lock.unlock()
if pendingDemand != .none {
subscription.request(pendingDemand)
}
}
func receive(_ input: Input) -> Subscribers.Demand {
lock.lock()
guard case .subscribed = state else {
let pending = self.pending.take()
lock.unlock()
pending.resumeAllWithNil()
return .none
}
precondition(!pending.isEmpty, "Received an output without requesting demand")
let continuation = pending.removeFirst()
lock.unlock()
continuation.resume(returning: input)
return .none
}
func receive(completion: Subscribers.Completion<Failure>) {
lock.lock()
state = .terminal
let pending = self.pending.take()
lock.unlock()
pending.resumeAllWithNil()
}
func cancel() {
lock.lock()
let pending = self.pending.take()
guard case .subscribed(let subscription) = state else {
state = .terminal
lock.unlock()
pending.resumeAllWithNil()
return
}
state = .terminal
lock.unlock()
subscription.cancel()
pending.resumeAllWithNil()
}
fileprivate func next() async -> Input? {
return await withUnsafeContinuation { continuation in
lock.lock()
switch state {
case .awaitingSubscription:
pending.append(continuation)
pendingDemand += 1
lock.unlock()
case .subscribed(let subscription):
pending.append(continuation)
lock.unlock()
subscription.request(.max(1))
case .terminal:
lock.unlock()
continuation.resume(returning: nil)
}
}
}
}
}
extension Publisher {
@available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
public var values: AsyncThrowingPublisher<Self> {
return .init(self)
}
}
@available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
public struct AsyncThrowingPublisher<Upstream: Publisher>: AsyncSequence
{
public typealias Element = Upstream.Output
public struct Iterator: AsyncIteratorProtocol {
public typealias Element = Upstream.Output
fileprivate let inner: Inner
public mutating func next() async throws -> Element? {
return try await withTaskCancellationHandler(
handler: { [inner] in inner.cancel() },
operation: { [inner] in try await inner.next() }
)
}
}
public typealias AsyncIterator = Iterator
private let publisher: Upstream
public init(_ publisher: Upstream) {
self.publisher = publisher
}
public func makeAsyncIterator() -> Iterator {
let inner = Iterator.Inner()
publisher.subscribe(inner)
return Iterator(inner: inner)
}
}
@available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
extension AsyncThrowingPublisher.Iterator {
fileprivate final class Inner: Subscriber, Cancellable {
typealias Input = Upstream.Output
typealias Failure = Upstream.Failure
private enum State {
case awaitingSubscription
case subscribed(Subscription)
case terminal(Error?)
}
private let lock = UnfairLock.allocate()
private var pending: [UnsafeContinuation<Input?, Error>] = []
private var state = State.awaitingSubscription
private var pendingDemand = Subscribers.Demand.none
deinit {
lock.deallocate()
}
func receive(subscription: Subscription) {
lock.lock()
guard case .awaitingSubscription = state else {
lock.unlock()
subscription.cancel()
return
}
state = .subscribed(subscription)
let pendingDemand = self.pendingDemand
self.pendingDemand = .none
lock.unlock()
if pendingDemand != .none {
subscription.request(pendingDemand)
}
}
func receive(_ input: Input) -> Subscribers.Demand {
lock.lock()
guard case .subscribed = state else {
let pending = self.pending.take()
lock.unlock()
pending.resumeAllWithNil()
return .none
}
precondition(!pending.isEmpty, "Received an output without requesting demand")
let continuation = pending.removeFirst()
lock.unlock()
continuation.resume(returning: input)
return .none
}
func receive(completion: Subscribers.Completion<Failure>) {
lock.lock()
switch state {
case .awaitingSubscription, .subscribed:
if let continuation = pending.first {
state = .terminal(nil)
let remaining = pending.take().dropFirst()
lock.unlock()
switch completion {
case .finished:
continuation.resume(returning: nil)
case .failure(let error):
continuation.resume(throwing: error)
}
remaining.resumeAllWithNil()
} else {
state = .terminal(completion.failure)
lock.unlock()
}
case .terminal:
let pending = self.pending.take()
lock.unlock()
pending.resumeAllWithNil()
}
}
func cancel() {
lock.lock()
let pending = self.pending.take()
guard case .subscribed(let subscription) = state else {
state = .terminal(nil)
lock.unlock()
pending.resumeAllWithNil()
return
}
state = .terminal(nil)
lock.unlock()
subscription.cancel()
pending.resumeAllWithNil()
}
fileprivate func next() async throws -> Input? {
return try await withUnsafeThrowingContinuation { continuation in
lock.lock()
switch state {
case .awaitingSubscription:
pending.append(continuation)
pendingDemand += 1
lock.unlock()
case .subscribed(let subscription):
pending.append(continuation)
lock.unlock()
subscription.request(.max(1))
case .terminal(nil):
lock.unlock()
continuation.resume(returning: nil)
case .terminal(let error?):
state = .terminal(nil)
lock.unlock()
continuation.resume(throwing: error)
}
}
}
}
}
@available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
extension Sequence {
fileprivate func resumeAllWithNil<Output, Failure: Error>()
where Element == UnsafeContinuation<Output?, Failure>
{
for continuation in self {
continuation.resume(returning: nil)
}
}
}
#endif
@@ -1,203 +0,0 @@
${template_header}
//
// Publisher+Concurrency.swift
//
//
// Created by Sergej Jaskiewicz on 28.08.2021.
//
#if canImport(_Concurrency) && compiler(>=5.5)
import _Concurrency
#endif
#if canImport(_Concurrency) && compiler(>=5.5) || compiler(>=5.5.1)
%{
instantiations = [('AsyncPublisher', False), ('AsyncThrowingPublisher', True)]
}%
% for instantiation, throwing in instantiations:
extension Publisher ${'' if throwing else 'where Failure == Never '}{
@available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
public var values: ${instantiation}<Self> {
return .init(self)
}
}
@available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
public struct ${instantiation}<Upstream: Publisher>: AsyncSequence
% if not throwing:
where Upstream.Failure == Never
% end
{
public typealias Element = Upstream.Output
public struct Iterator: AsyncIteratorProtocol {
public typealias Element = Upstream.Output
fileprivate let inner: Inner
public mutating func next() async ${'throws ' if throwing else ''}-> Element? {
return ${'try ' if throwing else ''}await withTaskCancellationHandler(
handler: { [inner] in inner.cancel() },
operation: { [inner] in ${'try ' if throwing else ''}await inner.next() }
)
}
}
public typealias AsyncIterator = Iterator
private let publisher: Upstream
public init(_ publisher: Upstream) {
self.publisher = publisher
}
public func makeAsyncIterator() -> Iterator {
let inner = Iterator.Inner()
publisher.subscribe(inner)
return Iterator(inner: inner)
}
}
@available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
extension ${instantiation}.Iterator {
fileprivate final class Inner: Subscriber, Cancellable {
typealias Input = Upstream.Output
typealias Failure = Upstream.Failure
private enum State {
case awaitingSubscription
case subscribed(Subscription)
case terminal${'(Error?)' if throwing else ''}
}
private let lock = UnfairLock.allocate()
private var pending: [UnsafeContinuation<Input?, ${'Error' if throwing else 'Never'}>] = []
private var state = State.awaitingSubscription
private var pendingDemand = Subscribers.Demand.none
deinit {
lock.deallocate()
}
func receive(subscription: Subscription) {
lock.lock()
guard case .awaitingSubscription = state else {
lock.unlock()
subscription.cancel()
return
}
state = .subscribed(subscription)
let pendingDemand = self.pendingDemand
self.pendingDemand = .none
lock.unlock()
if pendingDemand != .none {
subscription.request(pendingDemand)
}
}
func receive(_ input: Input) -> Subscribers.Demand {
lock.lock()
guard case .subscribed = state else {
let pending = self.pending.take()
lock.unlock()
pending.resumeAllWithNil()
return .none
}
precondition(!pending.isEmpty, "Received an output without requesting demand")
let continuation = pending.removeFirst()
lock.unlock()
continuation.resume(returning: input)
return .none
}
func receive(completion: Subscribers.Completion<Failure>) {
lock.lock()
% if throwing:
switch state {
case .awaitingSubscription, .subscribed:
if let continuation = pending.first {
state = .terminal(nil)
let remaining = pending.take().dropFirst()
lock.unlock()
switch completion {
case .finished:
continuation.resume(returning: nil)
case .failure(let error):
continuation.resume(throwing: error)
}
remaining.resumeAllWithNil()
} else {
state = .terminal(completion.failure)
lock.unlock()
}
case .terminal:
let pending = self.pending.take()
lock.unlock()
pending.resumeAllWithNil()
}
% else:
state = .terminal
let pending = self.pending.take()
lock.unlock()
pending.resumeAllWithNil()
% end
}
func cancel() {
lock.lock()
let pending = self.pending.take()
guard case .subscribed(let subscription) = state else {
state = .terminal${'(nil)' if throwing else ''}
lock.unlock()
pending.resumeAllWithNil()
return
}
state = .terminal${'(nil)' if throwing else ''}
lock.unlock()
subscription.cancel()
pending.resumeAllWithNil()
}
fileprivate func next() async ${'throws ' if throwing else ''}-> Input? {
return ${'try ' if throwing else ''}await withUnsafe${'Throwing' if throwing else ''}Continuation { continuation in
lock.lock()
switch state {
case .awaitingSubscription:
pending.append(continuation)
pendingDemand += 1
lock.unlock()
case .subscribed(let subscription):
pending.append(continuation)
lock.unlock()
subscription.request(.max(1))
case .terminal${'(nil)' if throwing else ''}:
lock.unlock()
continuation.resume(returning: nil)
% if throwing:
case .terminal(let error?):
state = .terminal(nil)
lock.unlock()
continuation.resume(throwing: error)
% end
}
}
}
}
}
% end
@available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
extension Sequence {
fileprivate func resumeAllWithNil<Output, Failure: Error>()
where Element == UnsafeContinuation<Output?, Failure>
{
for continuation in self {
continuation.resume(returning: nil)
}
}
}
#endif
@@ -7,18 +7,13 @@
/// A publisher that provides an explicit means of connecting and canceling publication.
///
/// Use a `ConnectablePublisher` when you need to perform additional configuration or
/// setup prior to producing any elements.
///
/// This publisher doesnt produce any elements until you call its `connect()` method.
///
/// Use `makeConnectable()` to create a `ConnectablePublisher` from any publisher whose
/// failure type is `Never`.
public protocol ConnectablePublisher: Publisher {
/// Connects to the publisher, allowing it to produce elements, and returns
/// an instance with which to cancel publishing.
/// Connects to the publisher and returns a `Cancellable` instance with which
/// to cancel publishing.
///
/// - Returns: A `Cancellable` instance that you use to cancel publishing.
/// - Returns: A `Cancellable` instance that can be used to cancel publishing.
func connect() -> Cancellable
}
+85 -180
View File
@@ -7,37 +7,28 @@
/// A subject that wraps a single value and publishes a new element whenever the value
/// changes.
///
/// Unlike `PassthroughSubject`, `CurrentValueSubject` maintains a buffer of the most
/// recently published element.
///
/// Calling `send(_:)` on a `CurrentValueSubject` also updates the current value, making
/// it equivalent to updating the `value` directly.
public final class CurrentValueSubject<Output, Failure: Error>: Subject {
private let lock = UnfairLock.allocate()
private let _lock = UnfairRecursiveLock.allocate()
private var active = true
// TODO: Combine uses bag data structure
private var _subscriptions: [Conduit] = []
private var completion: Subscribers.Completion<Failure>?
private var _value: Output
private var downstreams = ConduitList<Output, Failure>.empty
private var _completion: Subscribers.Completion<Failure>?
private var currentValue: Output
internal var upstreamSubscriptions: [Subscription] = []
private var upstreamSubscriptions: [Subscription] = []
internal var hasAnyDownstreamDemand = false
/// The value wrapped by this subject, published as a new element whenever it changes.
public var value: Output {
get {
lock.lock()
defer { lock.unlock() }
return currentValue
return _value
}
set {
lock.lock()
currentValue = newValue
sendValueAndConsumeLock(newValue)
send(newValue)
}
}
@@ -45,208 +36,122 @@ public final class CurrentValueSubject<Output, Failure: Error>: Subject {
///
/// - Parameter value: The initial value to publish.
public init(_ value: Output) {
self.currentValue = value
self._value = value
}
deinit {
for subscription in upstreamSubscriptions {
subscription.cancel()
for subscription in _subscriptions {
subscription._downstream = nil
}
lock.deallocate()
_lock.deallocate()
}
public func send(subscription: Subscription) {
lock.lock()
upstreamSubscriptions.append(subscription)
lock.unlock()
subscription.request(.unlimited)
_lock.do {
upstreamSubscriptions.append(subscription)
subscription.request(.unlimited)
}
}
public func receive<Downstream: Subscriber>(subscriber: Downstream)
where Output == Downstream.Input, Failure == Downstream.Failure
public func receive<Subscriber: OpenCombine.Subscriber>(subscriber: Subscriber)
where Output == Subscriber.Input, Failure == Subscriber.Failure
{
lock.lock()
if active {
let conduit = Conduit(parent: self, downstream: subscriber)
downstreams.insert(conduit)
lock.unlock()
subscriber.receive(subscription: conduit)
} else {
let completion = self.completion!
lock.unlock()
subscriber.receive(subscription: Subscriptions.empty)
subscriber.receive(completion: completion)
_lock.do {
if let completion = _completion {
subscriber.receive(subscription: Subscriptions.empty)
subscriber.receive(completion: completion)
return
} else {
let subscription = Conduit(parent: self,
downstream: AnySubscriber(subscriber))
_subscriptions.append(subscription)
subscriber.receive(subscription: subscription)
}
}
}
public func send(_ input: Output) {
lock.lock()
sendValueAndConsumeLock(input)
}
private func sendValueAndConsumeLock(_ newValue: Output) {
#if DEBUG
lock.assertOwner()
#endif
guard active else {
lock.unlock()
return
}
currentValue = newValue
let downstreams = self.downstreams
lock.unlock()
downstreams.forEach { conduit in
conduit.offer(newValue)
_lock.do {
_value = input
for subscription in _subscriptions where !subscription.isCompleted {
if subscription._demand > 0 {
subscription._offer(input)
subscription._demand -= 1
} else {
subscription._delivered = false
}
}
}
}
public func send(completion: Subscribers.Completion<Failure>) {
lock.lock()
guard active else {
lock.unlock()
return
_completion = completion
_lock.do {
for subscriber in _subscriptions {
subscriber._receive(completion: completion)
}
}
active = false
self.completion = completion
let downstreams = self.downstreams.take()
lock.unlock()
downstreams.forEach { conduit in
conduit.finish(completion: completion)
}
}
private func disassociate(_ conduit: ConduitBase<Output, Failure>) {
lock.lock()
guard active else {
lock.unlock()
return
}
downstreams.remove(conduit)
lock.unlock()
}
}
extension CurrentValueSubject {
private final class Conduit<Downstream: Subscriber>
: ConduitBase<Output, Failure>,
CustomStringConvertible,
CustomReflectable,
CustomPlaygroundDisplayConvertible
where Downstream.Input == Output, Downstream.Failure == Failure
{
fileprivate class Conduit: Subscription {
fileprivate var parent: CurrentValueSubject?
fileprivate var _parent: CurrentValueSubject?
fileprivate var downstream: Downstream?
fileprivate var _downstream: AnySubscriber<Output, Failure>?
fileprivate var demand = Subscribers.Demand.none
fileprivate var _demand: Subscribers.Demand = .none
private var lock = UnfairLock.allocate()
/// Whethere we satisfied the demand
fileprivate var _delivered = false
private var downstreamLock = UnfairRecursiveLock.allocate()
var isCompleted: Bool {
return _parent == nil
}
private var deliveredCurrentValue = false
fileprivate func _offer(_ value: Output) {
let newDemand = _downstream?.receive(value) ?? .none
_demand += newDemand
_delivered = true
}
fileprivate init(parent: CurrentValueSubject,
downstream: Downstream) {
self.parent = parent
self.downstream = downstream
downstream: AnySubscriber<Output, Failure>) {
_parent = parent
_downstream = downstream
}
deinit {
lock.deallocate()
downstreamLock.deallocate()
}
override func offer(_ output: Output) {
lock.lock()
guard demand > 0, let downstream = self.downstream else {
deliveredCurrentValue = false
lock.unlock()
return
fileprivate func _receive(completion: Subscribers.Completion<Failure>) {
if !isCompleted {
_parent = nil
_downstream?.receive(completion: completion)
}
demand -= 1
deliveredCurrentValue = true
lock.unlock()
downstreamLock.lock()
let newDemand = downstream.receive(output)
downstreamLock.unlock()
guard newDemand > 0 else { return }
lock.lock()
demand += newDemand
lock.unlock()
}
override func finish(completion: Subscribers.Completion<Failure>) {
lock.lock()
guard let downstream = self.downstream.take() else {
lock.unlock()
return
func request(_ demand: Subscribers.Demand) {
precondition(demand > 0)
_parent?._lock.do {
if !_delivered, let value = _parent?.value {
_offer(value)
_demand += demand
_demand -= 1
} else {
_demand = demand
}
_parent?.hasAnyDownstreamDemand = true
}
let parent = self.parent.take()
lock.unlock()
parent?.disassociate(self)
downstreamLock.lock()
downstream.receive(completion: completion)
downstreamLock.unlock()
}
override func request(_ demand: Subscribers.Demand) {
demand.assertNonZero()
lock.lock()
guard let downstream = self.downstream else {
lock.unlock()
return
}
if deliveredCurrentValue {
self.demand += demand
lock.unlock()
return
}
// Hasn't yet delivered the current value
self.demand += demand
deliveredCurrentValue = true
if let currentValue = self.parent?.value {
self.demand -= 1
lock.unlock()
downstreamLock.lock()
let newDemand = downstream.receive(currentValue)
downstreamLock.unlock()
guard newDemand > 0 else { return }
lock.lock()
self.demand += newDemand
}
lock.unlock()
func cancel() {
_parent = nil
}
override func cancel() {
lock.lock()
if downstream.take() == nil {
lock.unlock()
return
}
let parent = self.parent.take()
lock.unlock()
parent?.disassociate(self)
}
var description: String { return "CurrentValueSubject" }
var customMirror: Mirror {
lock.lock()
defer { lock.unlock() }
let children: [Mirror.Child] = [
("parent", parent as Any),
("downstream", downstream as Any),
("demand", demand),
("subject", parent as Any)
]
return Mirror(self, children: children)
}
var playgroundDescription: Any { return description }
}
}
extension CurrentValueSubject.Conduit: CustomStringConvertible {
fileprivate var description: String { return "CurrentValueSubject" }
}
@@ -5,18 +5,8 @@
// Created by Sergej Jaskiewicz on 10.06.2019.
//
/// A protocol for uniquely identifying publisher streams.
///
/// If you create a custom `Subscription` or `Subscriber` type, implement this protocol
/// so that development tools can uniquely identify publisher chains in your app.
/// If your type is a class, OpenCombine provides an implementation of `combineIdentifier`
/// for you.
/// If your type is a structure, set up the identifier as follows:
///
/// let combineIdentifier = CombineIdentifier()
public protocol CustomCombineIdentifierConvertible {
/// A unique identifier for identifying publisher streams.
var combineIdentifier: CombineIdentifier { get }
}
+76 -184
View File
@@ -5,222 +5,114 @@
// Created by Max Desiatov on 24/11/2019.
//
/// A publisher that eventually produces a single value and then finishes or fails.
public final class Future<Output, Failure: Error>: Publisher {
/// A publisher that eventually produces one value and then finishes or fails.
public final class Future<Output, Failure>: Publisher where Failure: Error {
/// A type that represents a closure to invoke in the future, when an element or error
/// is available.
///
/// The promise closure receives one parameter: a `Result` that contains either
/// a single element published by a `Future`, or an error.
public typealias Promise = (Result<Output, Failure>) -> Void
private let lock = UnfairLock.allocate()
private var downstreams = ConduitList<Output, Failure>.empty
private let _lock = UnfairRecursiveLock.allocate()
private var _subscriptions: [Conduit] = []
private var result: Result<Output, Failure>?
/// Creates a publisher that invokes a promise closure when the publisher emits
/// an element.
///
/// - Parameter attemptToFulfill: A `Promise` that the publisher invokes when
/// the publisher emits an element or terminates with an error.
public init(
_ attemptToFulfill: @escaping (@escaping Promise) -> Void
) {
attemptToFulfill(self.promise)
attemptToFulfill { result in
self._lock.do {
guard self.result == nil else { return }
self.result = result
self._publish(result)
}
}
}
deinit {
lock.deallocate()
_lock.deallocate()
}
private func promise(_ result: Result<Output, Failure>) {
lock.lock()
guard self.result == nil else {
lock.unlock()
return
}
self.result = result
let downstreams = self.downstreams.take()
lock.unlock()
switch result {
case .success(let output):
downstreams.forEach { $0.offer(output) }
case .failure(let error):
downstreams.forEach { $0.finish(completion: .failure(error)) }
/// This function is called to attach the specified `Subscriber` to this
/// `Publisher` by `subscribe(_:)`
///
/// - SeeAlso: `subscribe(_:)`
/// - Parameters:
/// - subscriber: The subscriber to attach to this `Publisher`.
/// once attached it can begin to receive values.
public func receive<Downstream: Subscriber>(
subscriber: Downstream
) where Output == Downstream.Input, Failure == Downstream.Failure {
let subscription = Conduit(parent: self,
downstream: AnySubscriber(subscriber))
_subscriptions.append(subscription)
subscriber.receive(subscription: subscription)
}
private func _acknowledgeDownstreamDemand() {
_lock.do {
guard let result = result else { return }
_publish(result)
}
}
public func receive<Downstream: Subscriber>(subscriber: Downstream)
where Output == Downstream.Input, Failure == Downstream.Failure
{
let conduit = Conduit(parent: self, downstream: subscriber)
lock.lock()
if let result = self.result {
downstreams.insert(conduit)
lock.unlock()
subscriber.receive(subscription: conduit)
conduit.fulfill(result)
} else {
downstreams.insert(conduit)
lock.unlock()
subscriber.receive(subscription: conduit)
}
}
private func _publish(_ result: Result<Output, Failure>) {
for subscription in self._subscriptions where !subscription._isCompleted {
switch result {
case let .success(output) where subscription._demand > 0:
subscription._demand -= 1
subscription._demand += subscription._downstream?.receive(output) ?? .none
subscription._receive(completion: .finished)
case let .failure(error):
subscription._receive(completion: .failure(error))
private func disassociate(_ conduit: ConduitBase<Output, Failure>) {
lock.lock()
downstreams.remove(conduit)
lock.unlock()
// nothing to do if no demand
default: ()
}
}
}
}
extension Future {
private final class Conduit<Downstream: Subscriber>
: ConduitBase<Output, Failure>,
CustomStringConvertible,
CustomReflectable,
CustomPlaygroundDisplayConvertible
where Downstream.Input == Output, Downstream.Failure == Failure
{
private enum State {
case active(Downstream, hasAnyDemand: Bool)
case terminal
fileprivate final class Conduit: Subscription {
var downstream: Downstream? {
switch self {
case .active(let downstream, hasAnyDemand: _):
return downstream
case .terminal:
return nil
}
}
fileprivate var _parent: Future<Output, Failure>?
var hasAnyDemand: Bool {
switch self {
case .active(_, let hasAnyDemand):
return hasAnyDemand
case .terminal:
return false
}
fileprivate var _downstream: AnySubscriber<Output, Failure>?
fileprivate var _demand: Subscribers.Demand = .none
fileprivate var _isCompleted: Bool {
return _parent == nil
}
fileprivate init(parent: Future<Output, Failure>,
downstream: AnySubscriber<Output, Failure>) {
_parent = parent
_downstream = downstream
}
fileprivate func _receive(completion: Subscribers.Completion<Failure>) {
if !_isCompleted {
_parent = nil
_downstream?.receive(completion: completion)
}
}
private var parent: Future?
private var state: State
private var lock = UnfairLock.allocate()
private var downstreamLock = UnfairRecursiveLock.allocate()
fileprivate init(parent: Future, downstream: Downstream) {
self.parent = parent
self.state = .active(downstream, hasAnyDemand: false)
}
deinit {
lock.deallocate()
downstreamLock.deallocate()
}
fileprivate func lockedFulfill(downstream: Downstream,
result: Result<Output, Failure>) {
switch result {
case .success(let output):
_ = downstream.receive(output)
downstream.receive(completion: .finished)
case .failure(let error):
downstream.receive(completion: .failure(error))
}
}
fileprivate func fulfill(_ result: Result<Output, Failure>) {
lock.lock()
guard case let .active(downstream, hasAnyDemand) = state else {
lock.unlock()
return
}
if case .success = result, !hasAnyDemand {
lock.unlock()
return
}
state = .terminal
lock.unlock()
downstreamLock.lock()
lockedFulfill(downstream: downstream, result: result)
let parent = self.parent.take()
downstreamLock.unlock()
parent?.disassociate(self)
}
override func offer(_ output: Output) {
fulfill(.success(output))
}
override func finish(completion: Subscribers.Completion<Failure>) {
switch completion {
case .finished:
assertionFailure("unreachable")
case .failure(let error):
fulfill(.failure(error))
}
}
override func request(_ demand: Subscribers.Demand) {
fileprivate func request(_ demand: Subscribers.Demand) {
demand.assertNonZero()
lock.lock()
guard case .active(let downstream, hasAnyDemand: _) = state else {
lock.unlock()
return
}
state = .active(downstream, hasAnyDemand: true)
if let parent = parent, let result = parent.result {
// If the promise is already resolved, send the result downstream
// immediately
state = .terminal
lock.unlock()
downstreamLock.lock()
lockedFulfill(downstream: downstream, result: result)
downstreamLock.unlock()
parent.disassociate(self)
} else {
lock.unlock()
_parent?._lock.do {
_demand += demand
}
_parent?._acknowledgeDownstreamDemand()
}
override func cancel() {
lock.lock()
switch state {
case .active:
state = .terminal
let parent = self.parent.take()
lock.unlock()
parent?.disassociate(self)
case .terminal:
lock.unlock()
}
fileprivate func cancel() {
_parent = nil
}
var description: String { return "Future" }
var customMirror: Mirror {
lock.lock()
defer { lock.unlock() }
let children: [Mirror.Child] = [
("parent", parent as Any),
("downstream", state.downstream as Any),
("hasAnyDemand", state.hasAnyDemand),
("subject", parent as Any)
]
return Mirror(self, children: children)
}
var playgroundDescription: Any { return description }
}
}
extension Future.Conduit: CustomStringConvertible {
fileprivate var description: String { return "Future" }
}
@@ -1,40 +0,0 @@
//
// ConduitBase.swift
//
//
// Created by Sergej Jaskiewicz on 25.06.2020.
//
internal class ConduitBase<Output, Failure: Error>: Subscription {
internal init() {}
internal func offer(_ output: Output) {
abstractMethod()
}
internal func finish(completion: Subscribers.Completion<Failure>) {
abstractMethod()
}
internal func request(_ demand: Subscribers.Demand) {
abstractMethod()
}
internal func cancel() {
abstractMethod()
}
}
extension ConduitBase: Equatable {
internal static func == (lhs: ConduitBase<Output, Failure>,
rhs: ConduitBase<Output, Failure>) -> Bool {
return ObjectIdentifier(lhs) == ObjectIdentifier(rhs)
}
}
extension ConduitBase: Hashable {
internal func hash(into hasher: inout Hasher) {
hasher.combine(ObjectIdentifier(self))
}
}
@@ -1,59 +0,0 @@
//
// ConduitList.swift
//
//
// Created by Sergej Jaskiewicz on 25.06.2020.
//
internal enum ConduitList<Output, Failure: Error> {
case empty
case single(ConduitBase<Output, Failure>)
case many(Set<ConduitBase<Output, Failure>>)
}
extension ConduitList: HasDefaultValue {
init() {
self = .empty
}
}
extension ConduitList {
internal mutating func insert(_ conduit: ConduitBase<Output, Failure>) {
switch self {
case .empty:
self = .single(conduit)
case .single(conduit):
break // This element already exists.
case .single(let existingConduit):
self = .many([existingConduit, conduit])
case .many(var set):
set.insert(conduit)
self = .many(set)
}
}
internal func forEach(
_ body: (ConduitBase<Output, Failure>) throws -> Void
) rethrows {
switch self {
case .empty:
break
case .single(let conduit):
try body(conduit)
case .many(let set):
try set.forEach(body)
}
}
internal mutating func remove(_ conduit: ConduitBase<Output, Failure>) {
switch self {
case .single(conduit):
self = .empty
case .empty, .single:
break
case .many(var set):
set.remove(conduit)
self = .many(set)
}
}
}
-177
View File
@@ -1,177 +0,0 @@
//
// DebugHook.swift
//
//
// Created by Sergej Jaskiewicz on 27.09.2020.
//
internal final class DebugHook {
private struct Handler: Hashable {
let handler: _Introspection
static func == (lhs: Handler, rhs: Handler) -> Bool {
return lhs.handler === rhs.handler
}
func hash(into hasher: inout Hasher) {
hasher.combine(ObjectIdentifier(handler))
}
}
internal static func getGlobalHook() -> DebugHook? {
globalLock.lock()
defer { globalLock.unlock() }
return globalHook
}
internal static func enable(_ handler: _Introspection) {
let hook: DebugHook
DebugHook.globalLock.lock()
defer { DebugHook.globalLock.unlock() }
if let _hook = DebugHook.globalHook {
hook = _hook
} else {
hook = DebugHook()
DebugHook.globalHook = hook
}
hook.lock.lock()
defer { hook.lock.unlock() }
hook.handlers.insert(Handler(handler: handler))
}
internal static func disable(_ handler: _Introspection) {
DebugHook.globalLock.lock()
defer { DebugHook.globalLock.unlock() }
guard let hook = DebugHook.globalHook else { return }
hook.lock.lock()
hook.handlers.remove(Handler(handler: handler))
let noMoreHandlers = hook.handlers.isEmpty
hook.lock.unlock()
if noMoreHandlers {
DebugHook.globalHook = nil
}
}
internal static func handlerIsEnabled(_ handler: _Introspection) -> Bool {
DebugHook.globalLock.lock()
defer { DebugHook.globalLock.unlock() }
guard let hook = DebugHook.globalHook else { return false }
hook.lock.lock()
defer { hook.lock.unlock() }
return hook.handlers.contains(Handler(handler: handler))
}
private static var globalHook: DebugHook?
private static let globalLock = UnfairLock.allocate()
private let lock = UnfairLock.allocate()
private var handlers = Set<Handler>()
internal var debugHandlers: [_Introspection] {
lock.lock()
defer { lock.unlock() }
return handlers.map { $0.handler }
}
private init() {}
deinit {
lock.deallocate()
}
internal func willReceive<Upstream: Publisher, Downstream: Subscriber>(
publisher: Upstream,
subscriber: Downstream
) where Upstream.Failure == Downstream.Failure, Upstream.Output == Downstream.Input {
for debugHandler in debugHandlers {
debugHandler.willReceive(publisher: publisher, subscriber: subscriber)
}
}
internal func didReceive<Upstream: Publisher, Downstream: Subscriber>(
publisher: Upstream,
subscriber: Downstream
) where Upstream.Failure == Downstream.Failure, Upstream.Output == Downstream.Input {
for debugHandler in debugHandlers {
debugHandler.didReceive(publisher: publisher, subscriber: subscriber)
}
}
internal func willReceive<Downstream: Subscriber>(subscriber: Downstream,
subscription: Subscription) {
for debugHandler in debugHandlers {
debugHandler.willReceive(subscriber: subscriber, subscription: subscription)
}
}
internal func didReceive<Downstream: Subscriber>(subscriber: Downstream,
subscription: Subscription) {
for debugHandler in debugHandlers {
debugHandler.didReceive(subscriber: subscriber, subscription: subscription)
}
}
internal func willReceive<Downstream: Subscriber>(subscriber: Downstream,
input: Downstream.Input) {
for debugHandler in debugHandlers {
debugHandler.willReceive(subscriber: subscriber, input: input)
}
}
internal func didReceive<Downstream: Subscriber>(
subscriber: Downstream,
input: Downstream.Input,
resultingDemand: Subscribers.Demand
) {
for debugHandler in debugHandlers {
debugHandler.didReceive(subscriber: subscriber,
input: input,
resultingDemand: resultingDemand)
}
}
internal func willReceive<Downstream: Subscriber>(
subscriber: Downstream,
completion: Subscribers.Completion<Downstream.Failure>
) {
for debugHandler in debugHandlers {
debugHandler.willReceive(subscriber: subscriber, completion: completion)
}
}
internal func didReceive<Downstream: Subscriber>(
subscriber: Downstream,
completion: Subscribers.Completion<Downstream.Failure>
) {
for debugHandler in debugHandlers {
debugHandler.didReceive(subscriber: subscriber, completion: completion)
}
}
internal func willRequest(subscription: Subscription, demand: Subscribers.Demand) {
for debugHandler in debugHandlers {
debugHandler.willRequest(subscription: subscription, demand)
}
}
internal func didRequest(subscription: Subscription, demand: Subscribers.Demand) {
for debugHandler in debugHandlers {
debugHandler.didRequest(subscription: subscription, demand)
}
}
internal func willCancel(subscription: Subscription) {
for debugHandler in debugHandlers {
debugHandler.willCancel(subscription: subscription)
}
}
internal func didCancel(subscription: Subscription) {
for debugHandler in debugHandlers {
debugHandler.didCancel(subscription: subscription)
}
}
}
@@ -9,7 +9,7 @@
///
/// Filter-like operators send an instance of their `Inner` class that is subclass
/// of this class to the upstream publisher (as subscriber) and
/// to the downstream subscriber (as subscription).
/// to the downstream subcriber (as subscription).
///
/// Filter-like operators include `Publishers.Filter`,
/// `Publishers.RemoveDuplicates`, `Publishers.PrefixWhile` and more.
@@ -24,6 +24,8 @@ internal class FilterProducer<Downstream: Subscriber,
CustomReflectable
where Downstream.Input == Output
{
// NOTE: This class has been audited for thread safety
// MARK: - State
private enum State {
+10 -17
View File
@@ -9,22 +9,15 @@
import COpenCombineHelpers
#endif
#if WASI
internal struct __UnfairLock { // swiftlint:disable:this type_name
internal static func allocate() -> UnfairLock { return .init() }
internal func lock() {}
internal func unlock() {}
internal func assertOwner() {}
internal func deallocate() {}
}
internal struct __UnfairRecursiveLock { // swiftlint:disable:this type_name
internal static func allocate() -> UnfairRecursiveLock { return .init() }
internal func lock() {}
internal func unlock() {}
internal func deallocate() {}
}
#endif // WASI
internal typealias UnfairLock = __UnfairLock
internal typealias UnfairRecursiveLock = __UnfairRecursiveLock
extension UnfairRecursiveLock {
@inlinable
internal func `do`<Result>(_ body: () throws -> Result) rethrows -> Result {
lock()
defer { unlock() }
return try body()
}
}
@@ -1,211 +0,0 @@
//
// PublishedSubject.swift
//
//
// Created by Sergej Jaskiewicz on 29.10.2020.
//
internal final class PublishedSubject<Output>: Subject {
internal typealias Failure = Never
private let lock = UnfairLock.allocate()
private var downstreams = ConduitList<Output, Failure>.empty
private var currentValue: Output
private var upstreamSubscriptions: [Subscription] = []
private var hasAnyDownstreamDemand = false
private var changePublisher: ObservableObjectPublisher?
internal var value: Output {
get {
lock.lock()
defer { lock.unlock() }
return currentValue
}
set {
send(newValue)
}
}
internal var objectWillChange: ObservableObjectPublisher? {
get {
lock.lock()
defer { lock.unlock() }
return changePublisher
}
set {
lock.lock()
defer { lock.unlock() }
changePublisher = newValue
}
}
internal init(_ value: Output) {
self.currentValue = value
}
deinit {
for subscription in upstreamSubscriptions {
subscription.cancel()
}
lock.deallocate()
}
internal func send(subscription: Subscription) {
lock.lock()
upstreamSubscriptions.append(subscription)
lock.unlock()
subscription.request(.unlimited)
}
internal func receive<Downstream: Subscriber>(subscriber: Downstream)
where Downstream.Input == Output, Downstream.Failure == Never
{
lock.lock()
let conduit = Conduit(parent: self, downstream: subscriber)
downstreams.insert(conduit)
lock.unlock()
subscriber.receive(subscription: conduit)
}
internal func send(_ input: Output) {
lock.lock()
let downstreams = self.downstreams
let changePublisher = self.changePublisher
lock.unlock()
changePublisher?.send()
downstreams.forEach { conduit in
conduit.offer(input)
}
lock.lock()
currentValue = input
lock.unlock()
}
internal func send(completion: Subscribers.Completion<Never>) {
fatalError("unreachable")
}
private func disassociate(_ conduit: ConduitBase<Output, Failure>) {
lock.lock()
downstreams.remove(conduit)
lock.unlock()
}
}
extension PublishedSubject {
private final class Conduit<Downstream: Subscriber>
: ConduitBase<Output, Failure>,
CustomStringConvertible,
CustomReflectable,
CustomPlaygroundDisplayConvertible
where Downstream.Input == Output, Downstream.Failure == Never
{
fileprivate var parent: PublishedSubject?
fileprivate var downstream: Downstream?
fileprivate var demand = Subscribers.Demand.none
private var lock = UnfairLock.allocate()
private var downstreamLock = UnfairRecursiveLock.allocate()
private var deliveredCurrentValue = false
fileprivate init(parent: PublishedSubject,
downstream: Downstream) {
self.parent = parent
self.downstream = downstream
}
deinit {
lock.deallocate()
downstreamLock.deallocate()
}
override func offer(_ output: Output) {
lock.lock()
guard demand > 0, let downstream = self.downstream else {
deliveredCurrentValue = false
lock.unlock()
return
}
demand -= 1
deliveredCurrentValue = true
lock.unlock()
downstreamLock.lock()
let newDemand = downstream.receive(output)
downstreamLock.unlock()
guard newDemand > 0 else { return }
lock.lock()
demand += newDemand
lock.unlock()
}
override func request(_ demand: Subscribers.Demand) {
demand.assertNonZero()
lock.lock()
guard let downstream = self.downstream else {
lock.unlock()
return
}
if deliveredCurrentValue {
self.demand += demand
lock.unlock()
return
}
// Hasn't yet delivered the current value
self.demand += demand
deliveredCurrentValue = true
if let currentValue = self.parent?.value {
self.demand -= 1
lock.unlock()
downstreamLock.lock()
let newDemand = downstream.receive(currentValue)
downstreamLock.unlock()
guard newDemand > 0 else { return }
lock.lock()
self.demand += newDemand
}
lock.unlock()
}
override func cancel() {
lock.lock()
if self.downstream == nil {
lock.unlock()
return
}
self.downstream = nil
let parent = self.parent.take()
lock.unlock()
parent?.disassociate(self)
}
var description: String { return "PublishedSubject" }
var customMirror: Mirror {
lock.lock()
defer { lock.unlock() }
let children: [Mirror.Child] = [
("parent", parent as Any),
("downstream", downstream as Any),
("demand", demand),
("subject", parent as Any)
]
return Mirror(self, children: children)
}
var playgroundDescription: Any { return description }
}
}
@@ -1,32 +0,0 @@
//
// PublishedSubscriber.swift
//
//
// Created by Sergej Jaskiewicz on 29.10.2020.
//
internal struct PublishedSubscriber<Value>: Subscriber {
internal typealias Input = Value
internal typealias Failure = Never
internal let combineIdentifier = CombineIdentifier()
private weak var subject: PublishedSubject<Value>?
internal init(_ subject: PublishedSubject<Value>) {
self.subject = subject
}
internal func receive(subscription: Subscription) {
subject?.send(subscription: subscription)
}
internal func receive(_ input: Value) -> Subscribers.Demand {
subject?.send(input)
return .none
}
internal func receive(completion: Subscribers.Completion<Never>) {}
}
@@ -9,7 +9,7 @@
///
/// Reduce-like operators send an instance of their `Inner` class that is subclass
/// of this class to the upstream publisher (as subscriber) and
/// to the downstream subscriber (as subscription).
/// to the downstream subcriber (as subsription).
///
/// Reduce-like operators include `Publishers.Reduce`, `Publishers.TryReduce`,
/// `Publishers.Count`, `Publishers.FirstWhere`, `Publishers.AllSatisfy` and more.
@@ -48,6 +48,8 @@ internal class ReduceProducer<Downstream: Subscriber,
private var upstreamCompleted = false
private var empty = true
internal init(downstream: Downstream, initial: Output?, reduce: Reducer) {
self.downstream = downstream
self.initial = initial
@@ -98,9 +100,7 @@ internal class ReduceProducer<Downstream: Subscriber,
return
}
upstreamCompleted = true
if downstreamRequested {
self.completed = true
}
self.completed = downstreamRequested || empty
let completed = self.completed
let result = self.result
lock.unlock()
@@ -157,6 +157,7 @@ extension ReduceProducer: Subscriber {
lock.unlock()
return .none
}
empty = false
lock.unlock()
// Combine doesn't hold the lock when calling `receive(newValue:)`.
@@ -5,6 +5,7 @@
// Created by Sergej Jaskiewicz on 16/09/2019.
//
// NOTE: This class has been audited for thread safety.
internal final class SubjectSubscriber<Downstream: Subject>
: Subscriber,
CustomStringConvertible,
@@ -13,7 +14,7 @@ internal final class SubjectSubscriber<Downstream: Subject>
Subscription
{
private let lock = UnfairLock.allocate()
private weak var downstreamSubject: Downstream?
private var downstreamSubject: Downstream?
private var upstreamSubscription: Subscription?
private var isCancelled: Bool { return downstreamSubject == nil }
@@ -39,21 +40,23 @@ internal final class SubjectSubscriber<Downstream: Subject>
internal func receive(_ input: Downstream.Output) -> Subscribers.Demand {
lock.lock()
guard let subject = downstreamSubject, upstreamSubscription != nil else {
guard let downstreamSubject = downstreamSubject else {
lock.unlock()
return .none
}
guard upstreamSubscription != nil else { APIViolationValueBeforeSubscription() }
lock.unlock()
subject.send(input)
downstreamSubject.send(input)
return .none
}
internal func receive(completion: Subscribers.Completion<Downstream.Failure>) {
lock.lock()
guard let subject = downstreamSubject, upstreamSubscription != nil else {
guard let subject = downstreamSubject else {
lock.unlock()
return
}
guard upstreamSubscription != nil else { APIViolationUnexpectedCompletion() }
lock.unlock()
subject.send(completion: completion)
downstreamSubject = nil
@@ -84,7 +87,11 @@ internal final class SubjectSubscriber<Downstream: Subject>
internal func cancel() {
lock.lock()
guard !isCancelled, let subscription = upstreamSubscription else {
if isCancelled {
lock.unlock()
return
}
guard let subscription = upstreamSubscription else {
lock.unlock()
return
}
@@ -1,69 +0,0 @@
//
// SubscriberTap.swift
//
//
// Created by Sergej Jaskiewicz on 27.09.2020.
//
internal protocol SubscriberTapMarker {
var inner: Any { mutating get }
}
internal struct SubscriberTap<Subscriber: OpenCombine.Subscriber>
: OpenCombine.Subscriber,
CustomStringConvertible,
SubscriberTapMarker
{
internal typealias Input = Subscriber.Input
internal typealias Failure = Subscriber.Failure
private let subscriber: Subscriber
internal lazy var inner: Any = AnySubscriber(self.subscriber)
internal init(subscriber: Subscriber) {
self.subscriber = subscriber
}
internal var combineIdentifier: CombineIdentifier {
return subscriber.combineIdentifier
}
internal func receive(subscription: Subscription) {
let hook = DebugHook.getGlobalHook()
if let subscriptionTap = subscription as? SubscriptionTap {
hook?.willReceive(subscriber: subscriber,
subscription: subscriptionTap.subscription)
subscriber.receive(subscription: subscriptionTap)
hook?.didReceive(subscriber: subscriber,
subscription: subscriptionTap.subscription)
} else {
hook?.willReceive(subscriber: subscriber, subscription: subscription)
subscriber
.receive(subscription: SubscriptionTap(subscription: subscription))
hook?.didReceive(subscriber: subscriber, subscription: subscription)
}
}
internal func receive(_ input: Input) -> Subscribers.Demand {
let hook = DebugHook.getGlobalHook()
hook?.willReceive(subscriber: subscriber, input: input)
let newDemand = subscriber.receive(input)
hook?.didReceive(subscriber: subscriber,
input: input,
resultingDemand: newDemand)
return newDemand
}
internal func receive(completion: Subscribers.Completion<Subscriber.Failure>) {
let hook = DebugHook.getGlobalHook()
hook?.willReceive(subscriber: subscriber, completion: completion)
subscriber.receive(completion: completion)
hook?.didReceive(subscriber: subscriber, completion: completion)
}
internal var description: String {
return String(describing: subscriber)
}
}
@@ -8,26 +8,5 @@
internal enum SubscriptionStatus {
case awaitingSubscription
case subscribed(Subscription)
case pendingTerminal(Subscription)
case terminal
}
extension SubscriptionStatus {
internal var isAwaitingSubscription: Bool {
switch self {
case .awaitingSubscription:
return true
default:
return false
}
}
internal var subscription: Subscription? {
switch self {
case .awaitingSubscription, .terminal:
return nil
case let .subscribed(subscription), let .pendingTerminal(subscription):
return subscription
}
}
}
@@ -1,33 +0,0 @@
//
// SubscriptionTap.swift
//
//
// Created by Sergej Jaskiewicz on 27.09.2020.
//
internal struct SubscriptionTap: Subscription, CustomStringConvertible {
internal let subscription: Subscription
internal var combineIdentifier: CombineIdentifier {
return subscription.combineIdentifier
}
internal func request(_ demand: Subscribers.Demand) {
let hook = DebugHook.getGlobalHook()
hook?.willRequest(subscription: subscription, demand: demand)
subscription.request(demand)
hook?.didRequest(subscription: subscription, demand: demand)
}
internal func cancel() {
let hook = DebugHook.getGlobalHook()
hook?.willCancel(subscription: subscription)
subscription.cancel()
hook?.didCancel(subscription: subscription)
}
internal var description: String {
return String(describing: subscription)
}
}
-30
View File
@@ -1,30 +0,0 @@
//
// Utils.swift
//
//
// Created by Sergej Jaskiewicz on 28.08.2021.
//
internal protocol HasDefaultValue {
init()
}
extension HasDefaultValue {
@inline(__always)
internal mutating func take() -> Self {
let taken = self
self = .init()
return taken
}
}
extension Array: HasDefaultValue {}
extension Dictionary: HasDefaultValue {}
extension Optional: HasDefaultValue {
init() {
self = nil
}
}
+2 -24
View File
@@ -8,8 +8,8 @@
/// A scheduler for performing synchronous actions.
///
/// You can only use this scheduler for immediate actions. If you attempt to schedule
/// actions after a specific date, this scheduler ignores the date and performs them
/// immediately.
/// actions after a specific date, this scheduler ignores the date and performs
/// them immediately.
public struct ImmediateScheduler: Scheduler {
/// The time type used by the immediate scheduler.
@@ -41,42 +41,29 @@ public struct ImmediateScheduler: Scheduler {
Codable,
SchedulerTimeIntervalConvertible {
/// The type used when evaluating floating-point literals.
public typealias FloatLiteralType = Double
/// The type used when evaluating integer literals.
public typealias IntegerLiteralType = Int
/// The type used for expressing the strides magnitude.
public typealias Magnitude = Int
/// The value of this time interval in seconds.
public var magnitude: Int
/// Creates an immediate scheduler time interval from the given time interval.
@inlinable
public init(_ value: Int) {
magnitude = value
}
/// Creates an immediate scheduler time interval from an integer seconds
/// value.
@inlinable
public init(integerLiteral value: Int) {
self.init(value)
}
/// Creates an immediate scheduler time interval from a floating-point seconds
/// value.
@inlinable
public init(floatLiteral value: Double) {
self.init(Int(value))
}
/// Creates an immediate scheduler time interval from a binary integer type.
///
/// If `exactly` cant convert to an `Int`, the resulting time interval is
/// `nil`.
@inlinable
public init?<BinaryIntegerType: BinaryInteger>(
exactly source: BinaryIntegerType
@@ -132,7 +119,6 @@ public struct ImmediateScheduler: Scheduler {
}
}
/// A type that defines options accepted by the immediate scheduler.
public typealias SchedulerOptions = Never
/// The shared instance of the immediate scheduler.
@@ -141,21 +127,15 @@ public struct ImmediateScheduler: Scheduler {
/// the shared instance.
public static let shared = ImmediateScheduler()
/// Performs the action at the next possible opportunity.
@inlinable
public func schedule(options: SchedulerOptions?, _ action: @escaping () -> Void) {
action()
}
/// The immediate schedulers definition of the current moment in time.
public var now: SchedulerTimeType { return SchedulerTimeType() }
/// The minimum tolerance allowed by the immediate scheduler.
public var minimumTolerance: SchedulerTimeType.Stride { return 0 }
/// Performs the action at some time after the specified date.
///
/// The immediate scheduler ignores `date` and performs the action immediately.
public func schedule(after date: SchedulerTimeType,
tolerance: SchedulerTimeType.Stride,
options: SchedulerOptions?,
@@ -165,8 +145,6 @@ public struct ImmediateScheduler: Scheduler {
/// Performs the action at some time after the specified date, at the specified
/// frequency, optionally taking into account tolerance if possible.
///
/// The immediate scheduler ignores `date` and performs the action immediately.
public func schedule(after date: SchedulerTimeType,
interval: SchedulerTimeType.Stride,
tolerance: SchedulerTimeType.Stride,
+21 -56
View File
@@ -7,8 +7,8 @@
/// A type of object with a publisher that emits before the object has changed.
///
/// By default an `ObservableObject` synthesizes an `objectWillChange` publisher that
/// emits the changed value before any of its `@Published` properties changes.
/// By default an `ObservableObject` will synthesize an `objectWillChange`
/// publisher that emits before any of its `@Published` properties changes:
///
/// class Contact : ObservableObject {
/// @Published var name: String
@@ -25,13 +25,11 @@
/// }
///
/// let john = Contact(name: "John Appleseed", age: 24)
/// cancellable = john.objectWillChange
/// .sink { _ in
/// print("\(john.age) will change")
/// }
/// print(john.haveBirthday())
/// // Prints "24 will change"
/// john.objectWillChange.sink { _ in print("will change") }
/// print(john.haveBirthday)
/// // Prints "will change"
/// // Prints "25"
///
public protocol ObservableObject: AnyObject {
/// The type of publisher that emits before the object has changed.
@@ -42,59 +40,27 @@ public protocol ObservableObject: AnyObject {
var objectWillChange: ObjectWillChangePublisher { get }
}
private protocol _ObservableObjectProperty {
var objectWillChange: ObservableObjectPublisher? { get nonmutating set }
}
#if swift(>=5.1)
extension Published: _ObservableObjectProperty {}
extension ObservableObject where ObjectWillChangePublisher == ObservableObjectPublisher {
// swiftlint:disable let_var_whitespace
#if swift(>=5.1)
/// A publisher that emits before the object has changed.
@available(*, unavailable, message: """
The default implementation of objectWillChange is not available yet. \
It's being worked on in \
https://github.com/broadwaylamb/OpenCombine/pull/97
""")
public var objectWillChange: ObservableObjectPublisher {
var installedPublisher: ObservableObjectPublisher?
var reflection: Mirror? = Mirror(reflecting: self)
while let aClass = reflection {
for (_, property) in aClass.children {
guard let property = property as? _ObservableObjectProperty else {
// Visit other fields until we meet a @Published field
continue
}
// Now we know that the field is @Published.
if let alreadyInstalledPublisher = property.objectWillChange {
installedPublisher = alreadyInstalledPublisher
// Don't visit other fields, as all @Published fields
// already have a publisher installed.
break
}
// Okay, this field doesn't have a publisher installed.
// This means that other fields don't have it either
// (because we install it only once and fields can't be added at runtime).
var lazilyCreatedPublisher: ObjectWillChangePublisher {
if let publisher = installedPublisher {
return publisher
}
let publisher = ObservableObjectPublisher()
installedPublisher = publisher
return publisher
}
property.objectWillChange = lazilyCreatedPublisher
// Continue visiting other fields.
}
reflection = aClass.superclassMirror
}
return installedPublisher ?? ObservableObjectPublisher()
fatalError("unimplemented")
}
#else
public var objectWillChange: ObservableObjectPublisher {
return ObservableObjectPublisher()
}
#endif
// swiftlint:enable let_var_whitespace
}
#endif
/// A publisher that publishes changes from observable objects.
/// The default publisher of an `ObservableObject`.
public final class ObservableObjectPublisher: Publisher {
public typealias Output = Void
@@ -108,7 +74,6 @@ public final class ObservableObjectPublisher: Publisher {
// TODO: Combine needs this for some reason
private var identifier: ObjectIdentifier?
/// Creates an observable object publisher instance.
public init() {}
deinit {
+72 -158
View File
@@ -5,24 +5,18 @@
// Created by Sergej Jaskiewicz on 11.06.2019.
//
/// A subject that broadcasts elements to downstream subscribers.
/// A subject that passes along values and completion.
///
/// As a concrete implementation of `Subject`, the `PassthroughSubject` provides
/// a convenient way to adapt existing imperative code to the Combine model.
///
/// Unlike `CurrentValueSubject`, a `PassthroughSubject` doesnt have an initial value or
/// a buffer of the most recently-published element.
/// A `PassthroughSubject` drops values if there are no subscribers, or its current demand
/// is zero.
public final class PassthroughSubject<Output, Failure: Error>: Subject {
/// Use a `PassthroughSubject` in unit tests when you want a publisher than can publish
/// specific values on-demand during tests.
public final class PassthroughSubject<Output, Failure: Error>: Subject {
private let lock = UnfairLock.allocate()
private let _lock = UnfairRecursiveLock.allocate()
private var active = true
private var _completion: Subscribers.Completion<Failure>?
private var completion: Subscribers.Completion<Failure>?
private var downstreams = ConduitList<Output, Failure>.empty
// TODO: Combine uses bag data structure
private var _subscriptions: [Conduit] = []
internal var upstreamSubscriptions: [Subscription] = []
@@ -31,192 +25,112 @@ public final class PassthroughSubject<Output, Failure: Error>: Subject {
public init() {}
deinit {
for subscription in upstreamSubscriptions {
subscription.cancel()
for subscription in _subscriptions {
subscription._downstream = nil
}
lock.deallocate()
_lock.deallocate()
}
public func send(subscription: Subscription) {
lock.lock()
upstreamSubscriptions.append(subscription)
let hasAnyDownstreamDemand = self.hasAnyDownstreamDemand
lock.unlock()
if hasAnyDownstreamDemand {
subscription.request(.unlimited)
_lock.do {
upstreamSubscriptions.append(subscription)
if hasAnyDownstreamDemand {
subscription.request(.unlimited)
}
}
}
public func receive<Downstream: Subscriber>(subscriber: Downstream)
where Output == Downstream.Input, Failure == Downstream.Failure
{
lock.lock()
if active {
let conduit = Conduit(parent: self, downstream: subscriber)
downstreams.insert(conduit)
lock.unlock()
subscriber.receive(subscription: conduit)
} else {
let completion = self.completion!
lock.unlock()
subscriber.receive(subscription: Subscriptions.empty)
subscriber.receive(completion: completion)
_lock.do {
if let completion = _completion {
subscriber.receive(subscription: Subscriptions.empty)
subscriber.receive(completion: completion)
return
} else {
let subscription = Conduit(parent: self,
downstream: AnySubscriber(subscriber))
_subscriptions.append(subscription)
subscriber.receive(subscription: subscription)
}
}
}
public func send(_ input: Output) {
lock.lock()
guard active else {
lock.unlock()
return
}
let downstreams = self.downstreams
lock.unlock()
downstreams.forEach { conduit in
conduit.offer(input)
_lock.do {
for subscription in _subscriptions
where !subscription._isCompleted && subscription._demand > 0
{
let newDemand = subscription._downstream?.receive(input) ?? .none
subscription._demand += newDemand
subscription._demand -= 1
}
}
}
public func send(completion: Subscribers.Completion<Failure>) {
lock.lock()
guard active else {
lock.unlock()
return
}
active = false
self.completion = completion
let downstreams = self.downstreams.take()
lock.unlock()
downstreams.forEach { conduit in
conduit.finish(completion: completion)
_lock.do {
_completion = completion
for subscriber in _subscriptions {
subscriber._receive(completion: completion)
}
}
}
private func acknowledgeDownstreamDemand() {
lock.lock()
if hasAnyDownstreamDemand {
lock.unlock()
return
private func _acknowledgeDownstreamDemand() {
_lock.do {
guard !hasAnyDownstreamDemand else { return }
hasAnyDownstreamDemand = true
for subscription in upstreamSubscriptions {
subscription.request(.unlimited)
}
}
hasAnyDownstreamDemand = true
let upstreamSubscriptions = self.upstreamSubscriptions
lock.unlock()
for subscription in upstreamSubscriptions {
subscription.request(.unlimited)
}
}
private func disassociate(_ conduit: ConduitBase<Output, Failure>) {
lock.lock()
guard active else {
lock.unlock()
return
}
downstreams.remove(conduit)
lock.unlock()
}
}
extension PassthroughSubject {
private final class Conduit<Downstream: Subscriber>
: ConduitBase<Output, Failure>,
CustomStringConvertible,
CustomReflectable,
CustomPlaygroundDisplayConvertible
where Downstream.Input == Output, Downstream.Failure == Failure
{
fileprivate final class Conduit: Subscription {
fileprivate var parent: PassthroughSubject?
fileprivate var _parent: PassthroughSubject?
fileprivate var downstream: Downstream?
fileprivate var _downstream: AnySubscriber<Output, Failure>?
fileprivate var demand = Subscribers.Demand.none
fileprivate var _demand: Subscribers.Demand = .none
private var lock = UnfairLock.allocate()
private var downstreamLock = UnfairRecursiveLock.allocate()
fileprivate var _isCompleted: Bool {
return _parent == nil
}
fileprivate init(parent: PassthroughSubject,
downstream: Downstream) {
self.parent = parent
self.downstream = downstream
downstream: AnySubscriber<Output, Failure>) {
_parent = parent
_downstream = downstream
}
deinit {
lock.deallocate()
downstreamLock.deallocate()
}
override func offer(_ output: Output) {
lock.lock()
guard demand > 0, let downstream = self.downstream else {
lock.unlock()
return
fileprivate func _receive(completion: Subscribers.Completion<Failure>) {
if !_isCompleted {
_parent = nil
_downstream?.receive(completion: completion)
}
demand -= 1
lock.unlock()
downstreamLock.lock()
let newDemand = downstream.receive(output)
downstreamLock.unlock()
guard newDemand > 0 else { return }
lock.lock()
demand += newDemand
lock.unlock()
}
override func finish(completion: Subscribers.Completion<Failure>) {
lock.lock()
guard let downstream = self.downstream.take() else {
lock.unlock()
return
}
let parent = self.parent.take()
lock.unlock()
parent?.disassociate(self)
downstreamLock.lock()
downstream.receive(completion: completion)
downstreamLock.unlock()
}
override func request(_ demand: Subscribers.Demand) {
fileprivate func request(_ demand: Subscribers.Demand) {
demand.assertNonZero()
lock.lock()
if self.downstream == nil {
lock.unlock()
return
_parent?._lock.do {
_demand += demand
}
self.demand += demand
let parent = self.parent
lock.unlock()
parent?.acknowledgeDownstreamDemand()
_parent?._acknowledgeDownstreamDemand()
}
override func cancel() {
lock.lock()
if downstream.take() == nil {
lock.unlock()
return
}
let parent = self.parent.take()
lock.unlock()
parent?.disassociate(self)
fileprivate func cancel() {
_parent = nil
}
var description: String { return "PassthroughSubject" }
var customMirror: Mirror {
lock.lock()
defer { lock.unlock() }
let children: [Mirror.Child] = [
("parent", parent as Any),
("downstream", downstream as Any),
("demand", demand),
("subject", parent as Any)
]
return Mirror(self, children: children)
}
var playgroundDescription: Any { return description }
}
}
extension PassthroughSubject.Conduit: CustomStringConvertible {
fileprivate var description: String { return "PassthroughSubject" }
}
+35 -158
View File
@@ -6,83 +6,30 @@
//
#if swift(>=5.1)
extension Publisher where Failure == Never {
/// Republishes elements received from a publisher, by assigning them to a property
/// marked as a publisher.
///
/// Use this operator when you want to receive elements from a publisher and republish
/// them through a property marked with the `@Published` attribute. The `assign(to:)`
/// operator manages the life cycle of the subscription, canceling the subscription
/// automatically when the `Published` instance deinitializes. Because of this,
/// the `assign(to:)` operator doesn't return an `AnyCancellable` that you're
/// responsible for like `assign(to:on:)` does.
///
/// The example below shows a model class that receives elements from an internal
/// `Timer.TimerPublisher`, and assigns them to a `@Published` property called
/// `lastUpdated`:
///
/// class MyModel: ObservableObject {
/// @Published var lastUpdated: Date = Date()
/// init() {
/// Timer.publish(every: 1.0, on: .main, in: .common)
/// .autoconnect()
/// .assign(to: $lastUpdated)
/// }
/// }
///
/// If you instead implemented `MyModel` with `assign(to: lastUpdated, on: self)`,
/// storing the returned `AnyCancellable` instance could cause a reference cycle,
/// because the `Subscribers.Assign` subscriber would hold a strong reference
/// to `self`. Using `assign(to:)` solves this problem.
///
/// - Parameter published: A property marked with the `@Published` attribute, which
/// receives and republishes all elements received from the upstream publisher.
public func assign(to published: inout Published<Output>.Publisher) {
subscribe(PublishedSubscriber(published.subject))
}
}
/// A type that publishes a property marked with an attribute.
/// Adds a `Publisher` to a property.
///
/// Publishing a property with the `@Published` attribute creates a publisher of this
/// type. You access the publisher with the `$` operator, as shown here:
///
/// class Weather {
/// @Published var temperature: Double
/// init(temperature: Double) {
/// self.temperature = temperature
/// }
/// }
///
/// let weather = Weather(temperature: 20)
/// cancellable = weather.$temperature
/// .sink() {
/// print ("Temperature now: \($0)")
/// }
/// weather.temperature = 25
///
/// // Prints:
/// // Temperature now: 20.0
/// // Temperature now: 25.0
///
/// When the property changes, publishing occurs in the property's `willSet` block,
/// meaning subscribers receive the new value before it's actually set on the property.
/// In the above example, the second time the sink executes its closure, it receives
/// the parameter value `25`. However, if the closure evaluated `weather.temperature`,
/// the value returned would be `20`.
///
/// > Important: The `@Published` attribute is class constrained. Use it with properties
/// of classes, not with non-class types like structures.
///
/// ### See Also
///
/// - `Publisher.assign(to:)`
/// Properties annotated with `@Published` contain both the stored value
/// and a publisher which sends any new values after the property value
/// has been sent. New subscribers will receive the current value
/// of the property first.
/// Note that the `@Published` property is class-constrained.
/// Use it with properties of classes, not with non-class types like structures.
@available(swift, introduced: 5.1)
@propertyWrapper
public struct Published<Value> {
/// Initialize the storage of the `Published` property as well as the corresponding
/// `Publisher`.
public init(initialValue: Value) {
self.init(wrappedValue: initialValue)
}
/// Initialize the storage of the `Published` property as well as the corresponding
/// `Publisher`.
public init(wrappedValue: Value) {
value = wrappedValue
}
/// A publisher for properties marked with the `@Published` attribute.
public struct Publisher: OpenCombine.Publisher {
@@ -90,100 +37,38 @@ public struct Published<Value> {
public typealias Failure = Never
fileprivate let subject: PublishedSubject<Value>
public func receive<Downstream: Subscriber>(subscriber: Downstream)
where Downstream.Input == Value, Downstream.Failure == Never
{
subject.subscribe(subscriber)
}
fileprivate let subject: OpenCombine.CurrentValueSubject<Value, Never>
fileprivate init(_ output: Output) {
subject = .init(output)
}
}
private enum Storage {
case value(Value)
case publisher(Publisher)
}
@propertyWrapper
private final class Box {
var wrappedValue: Storage
private var value: Value
init(wrappedValue: Storage) {
self.wrappedValue = wrappedValue
}
}
private var publisher: Publisher?
@Box private var storage: Storage
internal var objectWillChange: ObservableObjectPublisher?
internal var objectWillChange: ObservableObjectPublisher? {
get {
switch storage {
case .value:
return nil
case .publisher(let publisher):
return publisher.subject.objectWillChange
}
}
nonmutating set {
getPublisher().subject.objectWillChange = newValue
}
}
/// Creates the published instance with an initial wrapped value.
///
/// Don't use this initializer directly. Instead, create a property with
/// the `@Published` attribute, as shown here:
///
/// @Published var lastUpdated: Date = Date()
///
/// - Parameter wrappedValue: The publisher's initial value.
public init(initialValue: Value) {
self.init(wrappedValue: initialValue)
}
/// Creates the published instance with an initial value.
///
/// Don't use this initializer directly. Instead, create a property with
/// the `@Published` attribute, as shown here:
///
/// @Published var lastUpdated: Date = Date()
///
/// - Parameter initialValue: The publisher's initial value.
public init(wrappedValue: Value) {
_storage = Box(wrappedValue: .value(wrappedValue))
}
/// The property for which this instance exposes a publisher.
///
/// The `projectedValue` is the property accessed with the `$` operator.
/// The property that can be accessed with the `$` syntax and allows access to
/// the `Publisher`
public var projectedValue: Publisher {
mutating get {
return getPublisher()
}
set { // swiftlint:disable:this unused_setter_value
switch storage {
case .value(let value):
storage = .publisher(Publisher(value))
case .publisher:
break
if let publisher = publisher {
return publisher
}
let publisher = Publisher(value)
self.publisher = publisher
return publisher
}
}
/// Note: This method can mutate `storage`
internal func getPublisher() -> Publisher {
switch storage {
case .value(let value):
let publisher = Publisher(value)
storage = .publisher(publisher)
return publisher
case .publisher(let publisher):
return publisher
}
}
// swiftlint:disable let_var_whitespace
@available(*, unavailable, message: """
@Published is only available on properties of classes
@@ -200,20 +85,12 @@ public struct Published<Value> {
storage storageKeyPath: ReferenceWritableKeyPath<EnclosingSelf, Published<Value>>
) -> Value {
get {
switch object[keyPath: storageKeyPath].storage {
case .value(let value):
return value
case .publisher(let publisher):
return publisher.subject.value
}
return object[keyPath: storageKeyPath].value
}
set {
switch object[keyPath: storageKeyPath].storage {
case .value:
object[keyPath: storageKeyPath].storage = .publisher(Publisher(newValue))
case .publisher(let publisher):
publisher.subject.value = newValue
}
object[keyPath: storageKeyPath].objectWillChange?.send()
object[keyPath: storageKeyPath].publisher?.subject.send(newValue)
object[keyPath: storageKeyPath].value = newValue
}
// TODO: Benchmark and explore a possibility to use _modify
}
+16 -58
View File
@@ -7,40 +7,18 @@
/// Declares that a type can transmit a sequence of values over time.
///
/// A publisher delivers elements to one or more `Subscriber` instances.
/// The subscribers `Input` and `Failure` associated types must match the `Output` and
/// `Failure` types declared by the publisher.
/// The publisher implements the `receive(subscriber:)`method to accept a subscriber.
/// There are four kinds of messages:
/// subscription - A connection between `Publisher` and `Subscriber`.
/// value - An element in the sequence.
/// error - The sequence ended with an error (`.failure(e)`).
/// complete - The sequence ended successfully (`.finished`).
///
/// After this, the publisher can call the following methods on the subscriber:
/// - `receive(subscription:)`: Acknowledges the subscribe request and returns
/// a `Subscription` instance. The subscriber uses the subscription to demand elements
/// from the publisher and can use it to cancel publishing.
/// - `receive(_:)`: Delivers one element from the publisher to the subscriber.
/// - `receive(completion:)`: Informs the subscriber that publishing has ended,
/// either normally or with an error.
/// Both `.failure` and `.finished` are terminal messages.
///
/// Every `Publisher` must adhere to this contract for downstream subscribers to function
/// correctly.
/// You can summarize these possibilities with a regular expression:
/// value*(error|finished)?
///
/// Extensions on `Publisher` define a wide variety of _operators_ that you compose to
/// create sophisticated event-processing chains.
/// Each operator returns a type that implements the `Publisher` protocol
/// Most of these types exist as extensions on the `Publishers` enumeration.
/// For example, the `map(_:)` operator returns an instance of `Publishers.Map`.
///
/// # Creating Your Own Publishers
///
/// Rather than implementing the `Publisher` protocol yourself, you can create your own
/// publisher by using one of several types provided by the OpenCombine framework:
///
/// - Use a concrete subclass of `Subject`, such as `PassthroughSubject`, to publish
/// values on-demand by calling its `send(_:)` method.
/// - Use a `CurrentValueSubject` to publish whenever you update the subjects underlying
/// value.
/// - Add the `@Published` annotation to a property of one of your own types. In doing so,
/// the property gains a publisher that emits an event whenever the propertys value
/// changes. See the `Published` type for an example of this approach.
/// Every `Publisher` must adhere to this contract.
public protocol Publisher {
/// The kind of values published by this publisher.
@@ -51,15 +29,13 @@ public protocol Publisher {
/// Use `Never` if this `Publisher` does not publish errors.
associatedtype Failure: Error
/// Attaches the specified subscriber to this publisher.
/// This function is called to attach the specified `Subscriber` to this `Publisher`
/// by `subscribe(_:)`
///
/// Always call this function instead of `receive(subscriber:)`.
/// Adopters of `Publisher` must implement `receive(subscriber:)`. The implementation
/// of `subscribe(_:)` provided by `Publisher` calls through to
/// `receive(subscriber:)`.
///
/// - Parameter subscriber: The subscriber to attach to this publisher. After
/// attaching, the subscriber can start to receive values.
/// - SeeAlso: `subscribe(_:)`
/// - Parameters:
/// - subscriber: The subscriber to attach to this `Publisher`.
/// once attached it can begin to receive values.
func receive<Subscriber: OpenCombine.Subscriber>(subscriber: Subscriber)
where Failure == Subscriber.Failure, Output == Subscriber.Input
}
@@ -79,27 +55,9 @@ extension Publisher {
public func subscribe<Subscriber: OpenCombine.Subscriber>(_ subscriber: Subscriber)
where Failure == Subscriber.Failure, Output == Subscriber.Input
{
if let hook = DebugHook.getGlobalHook() {
if var marker = subscriber as? SubscriberTapMarker {
let anySubscriber = marker.inner
as! AnySubscriber<Subscriber.Input, Subscriber.Failure>
hook.willReceive(publisher: self, subscriber: anySubscriber)
receive(subscriber: subscriber)
hook.didReceive(publisher: self, subscriber: anySubscriber)
} else {
let tap = SubscriberTap(subscriber: subscriber)
hook.willReceive(publisher: self, subscriber: subscriber)
receive(subscriber: tap)
hook.didReceive(publisher: self, subscriber: subscriber)
}
} else {
receive(subscriber: subscriber)
}
receive(subscriber: subscriber)
}
/// Attaches the specified subject to this publisher.
///
/// - Parameter subject: The subject to attach to this publisher.
public func subscribe<Subject: OpenCombine.Subject>(
_ subject: Subject
) -> AnyCancellable
@@ -17,7 +17,7 @@ public struct Deferred<DeferredPublisher: Publisher>: Publisher {
/// Use `Never` if this `Publisher` does not publish errors.
public typealias Failure = DeferredPublisher.Failure
/// The closure to execute when this deferred publisher receives a subscription.
/// The closure to execute when it receives a subscription.
///
/// The publisher returned by this closure immediately
/// receives the incoming subscription.
@@ -24,7 +24,6 @@ public struct Empty<Output, Failure: Error>: Publisher, Equatable {
///
/// Use this initializer to connect the empty publisher to subscribers or other
/// publishers that have specific output and failure types.
///
/// - Parameters:
/// - completeImmediately: A Boolean value that indicates whether the publisher
/// should immediately finish.
@@ -20,7 +20,6 @@ public struct Fail<Output, Failure: Error>: Publisher {
///
/// Use this initializer to create a `Fail` publisher that can work with
/// subscribers or publishers that expect a given output type.
///
/// - Parameters:
/// - outputType: The output type exposed by this publisher.
/// - failure: The failure to send when terminating the publisher.
@@ -1,673 +0,0 @@
//
//
// Auto-generated from GYB template. DO NOT EDIT!
//
//
//
//
// Publishers.Catch.swift
//
//
// Created by Sergej Jaskiewicz on 25.12.2019.
//
extension Publisher {
/// Handles errors from an upstream publisher by replacing it with another publisher.
///
/// Use `catch()` to replace an error from an upstream publisher with a new publisher.
///
/// In the example below, the `catch()` operator handles the `SimpleError` thrown by
/// the upstream publisher by replacing the error with a `Just` publisher. This
/// continues the stream by publishing a single value and completing normally.
///
/// struct SimpleError: Error {}
/// let numbers = [5, 4, 3, 2, 1, 0, 9, 8, 7, 6]
/// cancellable = numbers.publisher
/// .tryLast(where: {
/// guard $0 != 0 else { throw SimpleError() }
/// return true
/// })
/// .catch { error in
/// Just(-1)
/// }
/// .sink { print("\($0)") }
/// // Prints: -1
///
/// Backpressure note: This publisher passes through `request` and `cancel` to
/// the upstream. After receiving an error, the publisher sends sends any unfulfilled
/// demand to the new `Publisher`.
///
/// - SeeAlso: `replaceError`
/// - Parameter handler: A closure that accepts the upstream failure as input and
/// returns a publisher to replace the upstream publisher.
/// - Returns: A publisher that handles errors from an upstream publisher by replacing
/// the failed publisher with another publisher.
public func `catch`<NewPublisher: Publisher>(
_ handler: @escaping (Failure) -> NewPublisher
) -> Publishers.Catch<Self, NewPublisher>
where NewPublisher.Output == Output
{
return .init(upstream: self, handler: handler)
}
/// Handles errors from an upstream publisher by either replacing it with another
/// publisher or throwing a new error.
///
/// Use `tryCatch(_:)` to decide how to handle from an upstream publisher by either
/// replacing the publisher with a new publisher, or throwing a new error.
///
/// In the example below, an array publisher emits values that a `tryMap(_:)` operator
/// evaluates to ensure the values are greater than zero. If the values arent greater
/// than zero, the operator throws an error to the downstream subscriber to let it
/// know there was a problem. The subscriber, `tryCatch(_:)`, replaces the error with
/// a new publisher using ``Just`` to publish a final value before the stream ends
/// normally.
///
/// enum SimpleError: Error { case error }
/// var numbers = [5, 4, 3, 2, 1, -1, 7, 8, 9, 10]
///
/// cancellable = numbers.publisher
/// .tryMap { v in
/// if v > 0 {
/// return v
/// } else {
/// throw SimpleError.error
/// }
/// }
/// .tryCatch { error in
/// Just(0) // Send a final value before completing normally.
/// // Alternatively, throw a new error to terminate the stream.
/// }
/// .sink(receiveCompletion: { print ("Completion: \($0).") },
/// receiveValue: { print ("Received \($0).") })
/// // Received 5.
/// // Received 4.
/// // Received 3.
/// // Received 2.
/// // Received 1.
/// // Received 0.
/// // Completion: finished.
///
/// - Parameter handler: A throwing closure that accepts the upstream failure as
/// input. This closure can either replace the upstream publisher with a new one,
/// or throw a new error to the downstream subscriber.
/// - Returns: A publisher that handles errors from an upstream publisher by replacing
/// the failed publisher with another publisher, or an error.
public func tryCatch<NewPublisher: Publisher>(
_ handler: @escaping (Failure) throws -> NewPublisher
) -> Publishers.TryCatch<Self, NewPublisher>
where NewPublisher.Output == Output
{
return .init(upstream: self, handler: handler)
}
}
extension Publishers {
/// A publisher that handles errors from an upstream publisher by replacing the failed
/// publisher with another publisher.
public struct Catch<Upstream: Publisher, NewPublisher: Publisher>: Publisher
where Upstream.Output == NewPublisher.Output
{
public typealias Output = Upstream.Output
public typealias Failure = NewPublisher.Failure
/// The publisher that this publisher receives elements from.
public let upstream: Upstream
/// A closure that accepts the upstream failure as input and returns a publisher
/// to replace the upstream publisher.
public let handler: (Upstream.Failure) -> NewPublisher
/// Creates a publisher that handles errors from an upstream publisher by
/// replacing the failed publisher with another publisher.
///
/// - Parameters:
/// - upstream: The publisher that this publisher receives elements from.
/// - handler: A closure that accepts the upstream failure as input and returns
/// a publisher to replace the upstream publisher.
public init(upstream: Upstream,
handler: @escaping (Upstream.Failure) -> NewPublisher) {
self.upstream = upstream
self.handler = handler
}
public func receive<Downstream: Subscriber>(subscriber: Downstream)
where Downstream.Input == Output, Downstream.Failure == Failure
{
let inner = Inner(downstream: subscriber, handler: handler)
let uncaughtS = Inner.UncaughtS(inner: inner)
upstream.subscribe(uncaughtS)
}
}
/// A publisher that handles errors from an upstream publisher by replacing
/// the failed publisher with another publisher or producing a new error.
///
/// Because this publishers handler can throw an error, `Publishers.TryCatch` defines
/// its `Failure` type as `Error`. This is different from `Publishers.Catch`, which
/// gets its failure type from the replacement publisher.
public struct TryCatch<Upstream: Publisher, NewPublisher: Publisher>: Publisher
where Upstream.Output == NewPublisher.Output
{
public typealias Output = Upstream.Output
public typealias Failure = Error
/// The publisher that this publisher receives elements from.
public let upstream: Upstream
/// A closure that accepts the upstream failure as input and either returns
/// a publisher to replace the upstream publisher or throws an error.
public let handler: (Upstream.Failure) throws -> NewPublisher
/// Creates a publisher that handles errors from an upstream publisher by
/// replacing the failed publisher with another publisher or by throwing an error.
///
/// - Parameters:
/// - upstream: The publisher that this publisher receives elements from.
/// - handler: A closure that accepts the upstream failure as input and either
/// returns a publisher to replace the upstream publisher. If this closure
/// throws an error, the publisher terminates with the thrown error.
public init(upstream: Upstream,
handler: @escaping (Upstream.Failure) throws -> NewPublisher) {
self.upstream = upstream
self.handler = handler
}
public func receive<Downstream: Subscriber>(subscriber: Downstream)
where Downstream.Input == Output, Downstream.Failure == Failure
{
let inner = Inner(downstream: subscriber, handler: handler)
let uncaughtS = Inner.UncaughtS(inner: inner)
upstream.subscribe(uncaughtS)
}
}
}
extension Publishers.Catch {
private final class Inner<Downstream: Subscriber>
: Subscription,
CustomStringConvertible,
CustomReflectable,
CustomPlaygroundDisplayConvertible
where Downstream.Input == Upstream.Output,
Downstream.Failure == NewPublisher.Failure
{
struct UncaughtS: Subscriber,
CustomStringConvertible,
CustomReflectable,
CustomPlaygroundDisplayConvertible
{
typealias Input = Upstream.Output
typealias Failure = Upstream.Failure
let inner: Inner
var combineIdentifier: CombineIdentifier { return inner.combineIdentifier }
func receive(subscription: Subscription) {
inner.receivePre(subscription: subscription)
}
func receive(_ input: Input) -> Subscribers.Demand {
return inner.receivePre(input)
}
func receive(completion: Subscribers.Completion<Failure>) {
return inner.receivePre(completion: completion)
}
var description: String { return inner.description }
var customMirror: Mirror { return inner.customMirror }
var playgroundDescription: Any { return description }
}
struct CaughtS: Subscriber,
CustomStringConvertible,
CustomReflectable,
CustomPlaygroundDisplayConvertible
{
typealias Input = NewPublisher.Output
typealias Failure = NewPublisher.Failure
let inner: Inner
var combineIdentifier: CombineIdentifier { return inner.combineIdentifier }
func receive(subscription: Subscription) {
inner.receivePost(subscription: subscription)
}
func receive(_ input: Input) -> Subscribers.Demand {
return inner.receivePost(input)
}
func receive(completion: Subscribers.Completion<Failure>) {
inner.receivePost(completion: completion)
}
var description: String { return inner.description }
var customMirror: Mirror { return inner.customMirror }
var playgroundDescription: Any { return description }
}
private enum State {
case pendingPre
case pre(Subscription)
case pendingPost
case post(Subscription)
case cancelled
}
private let lock = UnfairLock.allocate()
private var demand = Subscribers.Demand.none
private var state = State.pendingPre
private let downstream: Downstream
private let handler: (Upstream.Failure) -> NewPublisher
init(downstream: Downstream,
handler: @escaping (Upstream.Failure) -> NewPublisher) {
self.downstream = downstream
self.handler = handler
}
deinit {
lock.deallocate()
}
func receivePre(subscription: Subscription) {
lock.lock()
guard case .pendingPre = state else {
lock.unlock()
subscription.cancel()
return
}
state = .pre(subscription)
lock.unlock()
downstream.receive(subscription: self)
}
func receivePre(_ input: Upstream.Output) -> Subscribers.Demand {
lock.lock()
demand -= 1
lock.unlock()
let newDemand = downstream.receive(input)
lock.lock()
demand += newDemand
lock.unlock()
return newDemand
}
func receivePre(completion: Subscribers.Completion<Upstream.Failure>) {
switch completion {
case .finished:
lock.lock()
switch state {
case .pre:
state = .cancelled
lock.unlock()
downstream.receive(completion: .finished)
case .pendingPre, .pendingPost, .post, .cancelled:
lock.unlock()
}
case .failure(let error):
lock.lock()
switch state {
case .pre:
state = .pendingPost
lock.unlock()
handler(error).subscribe(CaughtS(inner: self))
case .cancelled:
lock.unlock()
case .pendingPre, .post, .pendingPost:
completionBeforeSubscription()
}
}
}
func receivePost(subscription: Subscription) {
lock.lock()
guard case .pendingPost = state else {
lock.unlock()
subscription.cancel()
return
}
state = .post(subscription)
let demand = self.demand
lock.unlock()
if demand > 0 {
subscription.request(demand)
}
}
func receivePost(_ input: NewPublisher.Output) -> Subscribers.Demand {
return downstream.receive(input)
}
func receivePost(completion: Subscribers.Completion<NewPublisher.Failure>) {
lock.lock()
guard case .post = state else {
lock.unlock()
return
}
state = .cancelled
lock.unlock()
downstream.receive(completion: completion)
}
func request(_ demand: Subscribers.Demand) {
demand.assertNonZero()
lock.lock()
switch state {
case .pendingPre:
// The client is only able to call the `request` method after we've sent
// `self` downstream. We only do it in the `receivePre(subscription:)`
// method, after setting `state` to `pre`.
// After that `state` never becomes `pendingPre`.
requestBeforeSubscription()
case let .pre(subscription):
self.demand += demand
lock.unlock()
subscription.request(demand)
case .pendingPost:
self.demand += demand
lock.unlock()
case let .post(subscription):
lock.unlock()
subscription.request(demand)
case .cancelled:
lock.unlock()
}
}
func cancel() {
lock.lock()
switch state {
case let .pre(subscription), let .post(subscription):
state = .cancelled
lock.unlock()
subscription.cancel()
case .pendingPre, .pendingPost, .cancelled:
lock.unlock()
}
}
var description: String { return "Catch" }
var customMirror: Mirror {
let children: [Mirror.Child] = [
("downstream", downstream),
("demand", demand)
]
return Mirror(self, children: children)
}
var playgroundDescription: Any { return description }
}
}
extension Publishers.TryCatch {
private final class Inner<Downstream: Subscriber>
: Subscription,
CustomStringConvertible,
CustomReflectable,
CustomPlaygroundDisplayConvertible
where Downstream.Input == Upstream.Output,
Downstream.Failure == Error
{
struct UncaughtS: Subscriber,
CustomStringConvertible,
CustomReflectable,
CustomPlaygroundDisplayConvertible
{
typealias Input = Upstream.Output
typealias Failure = Upstream.Failure
let inner: Inner
var combineIdentifier: CombineIdentifier { return inner.combineIdentifier }
func receive(subscription: Subscription) {
inner.receivePre(subscription: subscription)
}
func receive(_ input: Input) -> Subscribers.Demand {
return inner.receivePre(input)
}
func receive(completion: Subscribers.Completion<Failure>) {
return inner.receivePre(completion: completion)
}
var description: String { return inner.description }
var customMirror: Mirror { return inner.customMirror }
var playgroundDescription: Any { return description }
}
struct CaughtS: Subscriber,
CustomStringConvertible,
CustomReflectable,
CustomPlaygroundDisplayConvertible
{
typealias Input = NewPublisher.Output
typealias Failure = NewPublisher.Failure
let inner: Inner
var combineIdentifier: CombineIdentifier { return inner.combineIdentifier }
func receive(subscription: Subscription) {
inner.receivePost(subscription: subscription)
}
func receive(_ input: Input) -> Subscribers.Demand {
return inner.receivePost(input)
}
func receive(completion: Subscribers.Completion<Failure>) {
inner.receivePost(completion: completion)
}
var description: String { return inner.description }
var customMirror: Mirror { return inner.customMirror }
var playgroundDescription: Any { return description }
}
private enum State {
case pendingPre
case pre(Subscription)
case pendingPost
case post(Subscription)
case cancelled
}
private let lock = UnfairLock.allocate()
private var demand = Subscribers.Demand.none
private var state = State.pendingPre
private let downstream: Downstream
private let handler: (Upstream.Failure) throws -> NewPublisher
init(downstream: Downstream,
handler: @escaping (Upstream.Failure) throws -> NewPublisher) {
self.downstream = downstream
self.handler = handler
}
deinit {
lock.deallocate()
}
func receivePre(subscription: Subscription) {
lock.lock()
guard case .pendingPre = state else {
lock.unlock()
subscription.cancel()
return
}
state = .pre(subscription)
lock.unlock()
downstream.receive(subscription: self)
}
func receivePre(_ input: Upstream.Output) -> Subscribers.Demand {
lock.lock()
demand -= 1
lock.unlock()
let newDemand = downstream.receive(input)
lock.lock()
demand += newDemand
lock.unlock()
return newDemand
}
func receivePre(completion: Subscribers.Completion<Upstream.Failure>) {
switch completion {
case .finished:
lock.lock()
switch state {
case .pre:
state = .cancelled
lock.unlock()
downstream.receive(completion: .finished)
case .pendingPre, .pendingPost, .post, .cancelled:
lock.unlock()
}
case .failure(let error):
lock.lock()
switch state {
case .pre:
state = .pendingPost
lock.unlock()
do {
try handler(error).subscribe(CaughtS(inner: self))
} catch let anotherError {
lock.lock()
state = .cancelled
lock.unlock()
downstream.receive(completion: .failure(anotherError))
}
case .cancelled:
lock.unlock()
case .pendingPre, .post, .pendingPost:
completionBeforeSubscription()
}
}
}
func receivePost(subscription: Subscription) {
lock.lock()
guard case .pendingPost = state else {
lock.unlock()
subscription.cancel()
return
}
state = .post(subscription)
let demand = self.demand
lock.unlock()
if demand > 0 {
subscription.request(demand)
}
}
func receivePost(_ input: NewPublisher.Output) -> Subscribers.Demand {
return downstream.receive(input)
}
func receivePost(completion: Subscribers.Completion<NewPublisher.Failure>) {
lock.lock()
guard case .post = state else {
lock.unlock()
return
}
state = .cancelled
lock.unlock()
downstream.receive(completion: completion.eraseError())
}
func request(_ demand: Subscribers.Demand) {
demand.assertNonZero()
lock.lock()
switch state {
case .pendingPre:
// The client is only able to call the `request` method after we've sent
// `self` downstream. We only do it in the `receivePre(subscription:)`
// method, after setting `state` to `pre`.
// After that `state` never becomes `pendingPre`.
requestBeforeSubscription()
case let .pre(subscription):
self.demand += demand
lock.unlock()
subscription.request(demand)
case .pendingPost:
self.demand += demand
lock.unlock()
case let .post(subscription):
lock.unlock()
subscription.request(demand)
case .cancelled:
lock.unlock()
}
}
func cancel() {
lock.lock()
switch state {
case let .pre(subscription), let .post(subscription):
state = .cancelled
lock.unlock()
subscription.cancel()
case .pendingPre, .pendingPost, .cancelled:
lock.unlock()
}
}
var description: String { return "TryCatch" }
var customMirror: Mirror {
let children: [Mirror.Child] = [
("downstream", downstream),
("demand", demand)
]
return Mirror(self, children: children)
}
var playgroundDescription: Any { return description }
}
}
private func completionBeforeSubscription(file: StaticString = #file,
line: UInt = #line) -> Never {
fatalError("Unexpected state: received completion but do not have subscription",
file: file,
line: line)
}
private func requestBeforeSubscription(file: StaticString = #file,
line: UInt = #line) -> Never {
fatalError("Unexpected state: request before subscription sent",
file: file,
line: line)
}
+22 -156
View File
@@ -13,100 +13,16 @@
extension Publisher {
/// Encodes the output from upstream using a specified encoder.
///
/// Use `encode(encoder:)` with a `JSONDecoder` (or a `PropertyListDecoder` for
/// property lists) to encode an `Encodable` struct into `Data` that could be used to
/// make a JSON string (or written to disk as a binary plist in the case of property
/// lists).
///
/// In this example, a `PassthroughSubject` publishes an `Article`.
/// The `encode(encoder:)` operator encodes the properties of the `Article` struct
/// into a new JSON string according to the `Codable` protocol adopted by `Article`.
/// The operator publishes the resulting JSON string to the downstream subscriber.
/// If the encoding operation fails, which can happen in the case of complex
/// properties that cant be directly transformed into JSON, the stream terminates
/// and the error is passed to the downstream subscriber.
///
/// struct Article: Codable {
/// let title: String
/// let author: String
/// let pubDate: Date
/// }
///
/// let dataProvider = PassthroughSubject<Article, Never>()
/// let cancellable = dataProvider
/// .encode(encoder: JSONEncoder())
/// .sink(receiveCompletion: { print ("Completion: \($0)") },
/// receiveValue: { data in
/// guard let stringRepresentation =
/// String(data: data, encoding: .utf8) else { return }
/// print("""
/// Data received \(data) string representation: \
/// \(stringRepresentation)
/// """)
/// })
///
/// dataProvider.send(Article(title: "My First Article",
/// author: "Gita Kumar",
/// pubDate: Date()))
///
/// // Prints: "Data received 86 bytes string representation:
/// // {"title":"My First Article","author":"Gita Kumar"
/// // "pubDate":606211803.279603}"
///
/// - Parameter encoder: An encoder that implements the `TopLevelEncoder` protocol.
/// - Returns: A publisher that encodes received elements using a specified encoder,
/// and publishes the resulting data.
/// Encodes the output from upstream using a specified `TopLevelEncoder`.
/// For example, use `JSONEncoder`.
public func encode<Coder: TopLevelEncoder>(
encoder: Coder
) -> Publishers.Encode<Self, Coder> {
return .init(upstream: self, encoder: encoder)
}
/// Decodes the output from the upstream using a specified decoder.
///
/// Use `decode(type:decoder:)` with a `JSONDecoder` (or a `PropertyListDecoder` for
/// property lists) to decode data received from a `URLSession.DataTaskPublisher` or
/// other data source using the `Decodable` protocol.
///
/// In this example, a `PassthroughSubject` publishes a JSON string. The JSON decoder
/// parses the string, converting its fields according to the `Decodable` protocol
/// implemented by `Article`, and successfully populating a new `Article`.
/// The `Publishers.Decode` publisher then publishes the `Article` to the downstream.
/// If a decoding operation fails, which happens in the case of missing or malformed
/// data in the source JSON string, the stream terminates and passes the error to
/// the downstream subscriber.
///
/// struct Article: Codable {
/// let title: String
/// let author: String
/// let pubDate: Date
/// }
///
/// let dataProvider = PassthroughSubject<Data, Never>()
/// cancellable = dataProvider
/// .decode(type: Article.self, decoder: JSONDecoder())
/// .sink(receiveCompletion: { print ("Completion: \($0)")},
/// receiveValue: { print ("value: \($0)") })
///
/// dataProvider.send(Data("""
/// {\"pubDate\":1574273638.575666, \
/// \"title\" : \"My First Article\", \
/// \"author\" : \"Gita Kumar\" }
/// """.utf8))
///
/// // Prints:
/// // ".sink() data received Article(title: "My First Article",
/// // author: "Gita Kumar",
/// // pubDate: 2050-11-20 18:13:58 +0000)"
///
/// - Parameters:
/// - type: The encoded data to decode into a struct that conforms to
/// the `Decodable` protocol.
/// - decoder: A decoder that implements the `TopLevelDecoder` protocol.
/// - Returns: A publisher that decodes a given type using a specified decoder and
/// publishes the result.
/// Decodes the output from upstream using a specified `TopLevelDecoder`.
/// For example, use `JSONDecoder`.
public func decode<Item: Decodable, Coder: TopLevelDecoder>(
type: Item.Type,
decoder: Coder
@@ -172,6 +88,9 @@ extension Publishers.Encode {
CustomPlaygroundDisplayConvertible
where Downstream.Input == Output, Downstream.Failure == Error
{
// NOTE: This class has been audited for thread safety.
// Combine doesn't use any locking here.
typealias Input = Upstream.Output
typealias Failure = Upstream.Failure
@@ -180,8 +99,6 @@ extension Publishers.Encode {
private let encode: (Upstream.Output) throws -> Output
private let lock = UnfairLock.allocate()
private var finished = false
private var subscription: Subscription?
@@ -194,70 +111,44 @@ extension Publishers.Encode {
self.encode = encode
}
deinit {
lock.deallocate()
}
func receive(subscription: Subscription) {
lock.lock()
if finished || self.subscription != nil {
lock.unlock()
subscription.cancel()
return
}
self.subscription = subscription
lock.unlock()
downstream.receive(subscription: self)
}
func receive(_ input: Input) -> Subscribers.Demand {
lock.lock()
if finished {
lock.unlock()
return .none
}
lock.unlock()
if finished { return .none }
do {
return try downstream.receive(encode(input))
} catch {
lock.lock()
finished = true
let subscription = self.subscription.take()
lock.unlock()
subscription?.cancel()
subscription = nil
downstream.receive(completion: .failure(error))
return .none
}
}
func receive(completion: Subscribers.Completion<Failure>) {
lock.lock()
if finished {
lock.unlock()
return
}
if finished { return }
finished = true
subscription = nil
lock.unlock()
downstream.receive(completion: completion.eraseError())
}
func request(_ demand: Subscribers.Demand) {
lock.lock()
let subscription = self.subscription
lock.unlock()
subscription?.request(demand)
}
func cancel() {
lock.lock()
guard !finished, let subscription = self.subscription.take() else {
lock.unlock()
return
}
finished = true
lock.unlock()
guard let subscription = self.subscription, !finished else { return }
subscription.cancel()
self.subscription = nil
finished = true
}
var description: String { return "Encode" }
@@ -284,6 +175,9 @@ extension Publishers.Decode {
CustomPlaygroundDisplayConvertible
where Downstream.Input == Output, Downstream.Failure == Error
{
// NOTE: This class has been audited for thread safety.
// Combine doesn't use any locking here.
typealias Input = Upstream.Output
typealias Failure = Upstream.Failure
@@ -292,8 +186,6 @@ extension Publishers.Decode {
private let decode: (Upstream.Output) throws -> Output
private let lock = UnfairLock.allocate()
private var finished = false
private var subscription: Subscription?
@@ -306,70 +198,44 @@ extension Publishers.Decode {
self.decode = decode
}
deinit {
lock.deallocate()
}
func receive(subscription: Subscription) {
lock.lock()
if finished || self.subscription != nil {
lock.unlock()
subscription.cancel()
return
}
self.subscription = subscription
lock.unlock()
downstream.receive(subscription: self)
}
func receive(_ input: Input) -> Subscribers.Demand {
lock.lock()
if finished {
lock.unlock()
return .none
}
lock.unlock()
if finished { return .none }
do {
return try downstream.receive(decode(input))
} catch {
lock.lock()
finished = true
let subscription = self.subscription.take()
lock.unlock()
subscription?.cancel()
subscription = nil
downstream.receive(completion: .failure(error))
return .none
}
}
func receive(completion: Subscribers.Completion<Failure>) {
lock.lock()
if finished {
lock.unlock()
return
}
if finished { return }
finished = true
subscription = nil
lock.unlock()
downstream.receive(completion: completion.eraseError())
}
func request(_ demand: Subscribers.Demand) {
lock.lock()
let subscription = self.subscription
lock.unlock()
subscription?.request(demand)
}
func cancel() {
lock.lock()
guard !finished, let subscription = self.subscription.take() else {
lock.unlock()
return
}
finished = true
lock.unlock()
guard let subscription = self.subscription, !finished else { return }
subscription.cancel()
self.subscription = nil
finished = true
}
var description: String { return "Decode" }
@@ -12,29 +12,11 @@
//
extension Publisher {
/// Publishes the value of the key path.
///
/// In the following example, the `map(_:)` operator uses the Swift
/// key path syntax to access the `die` member
/// of the `DiceRoll` structure published by the `Just` publisher.
///
/// The downstream sink subscriber receives only
/// the value of this `Int`,
/// not the entire `DiceRoll`.
///
/// struct DiceRoll {
/// let die: Int
/// }
///
/// cancellable = Just(DiceRoll(die: Int.random(in: 1...6)))
/// .map(\.die)
/// .sink {
/// print ("Rolled: \($0)")
/// }
/// // Prints "Rolled: 6 (or some other random value).
/// Returns a publisher that publishes the values of a keyt path as a tuple.
///
/// - Parameters:
/// - keyPath: The key path of a property on `Output`.
/// - keyPath: The key path of a property on `Output`
/// - Returns: A publisher that publishes the value of the key path.
public func map<Result>(
_ keyPath: KeyPath<Output, Result>
@@ -44,35 +26,12 @@ extension Publisher {
keyPath: keyPath
)
}
/// Publishes the values of two key paths as a tuple.
///
/// In the following example, the `map(_:_:)` operator uses the Swift
/// key path syntax to access the `die1` and `die2` members
/// of the `DiceRoll` structure published by the `Just` publisher.
///
/// The downstream sink subscriber receives only
/// these two values (as an `(Int, Int)` tuple),
/// not the entire `DiceRoll`.
///
/// struct DiceRoll {
/// let die1: Int
/// let die2: Int
/// }
///
/// cancellable = Just(DiceRoll(die1: Int.random(in: 1...6),
/// die2: Int.random(in: 1...6)))
/// .map(\.die1, \.die2)
/// .sink { values in
/// print("""
/// Rolled: \(values.0), \(values.1) \
/// (total \(values.0 + values.1))
/// """)
/// }
/// // Prints "Rolled: 5, 3 (total: 8)" (or other random values).
/// Returns a publisher that publishes the values of two key paths as a tuple.
///
/// - Parameters:
/// - keyPath0: The key path of a property on `Output`.
/// - keyPath1: The key path of another property on `Output`.
/// - keyPath0: The key path of a property on `Output`
/// - keyPath1: The key path of another property on `Output`
/// - Returns: A publisher that publishes the values of two key paths as a tuple.
public func map<Result0, Result1>(
_ keyPath0: KeyPath<Output, Result0>,
@@ -84,38 +43,13 @@ extension Publisher {
keyPath1: keyPath1
)
}
/// Publishes the values of three key paths as a tuple.
///
/// In the following example, the `map(_:_:_:)` operator uses the Swift
/// key path syntax to access the `die1`, `die2`, and `die3` members
/// of the `DiceRoll` structure published by the `Just` publisher.
///
/// The downstream sink subscriber receives only
/// these three values (as an `(Int, Int, Int)` tuple),
/// not the entire `DiceRoll`.
///
/// struct DiceRoll {
/// let die1: Int
/// let die2: Int
/// let die3: Int
/// }
///
/// cancellable = Just(DiceRoll(die1: Int.random(in: 1...6),
/// die2: Int.random(in: 1...6),
/// die3: Int.random(in: 1...6)))
/// .map(\.die1, \.die2, \.die3)
/// .sink { values in
/// print("""
/// Rolled: \(values.0), \(values.1), \(values.2) \
/// (total \(values.0 + values.1 + values.2))
/// """)
/// }
/// // Prints "Rolled: 2, 4, 3 (total: 9)" (or other random values).
/// Returns a publisher that publishes the values of three key paths as a tuple.
///
/// - Parameters:
/// - keyPath0: The key path of a property on `Output`.
/// - keyPath1: The key path of a second property on `Output`.
/// - keyPath2: The key path of a third property on `Output`.
/// - keyPath0: The key path of a property on `Output`
/// - keyPath1: The key path of another property on `Output`
/// - keyPath2: The key path of a third property on `Output`
/// - Returns: A publisher that publishes the values of three key paths as a tuple.
public func map<Result0, Result1, Result2>(
_ keyPath0: KeyPath<Output, Result0>,
@@ -0,0 +1,952 @@
//
//
// Auto-generated from GYB template. DO NOT EDIT!
//
//
//
//
// Publishers.Merge.swift.gyb
//
//
// Created by Sergej Jaskiewicz on 04/10/2019.
//
// swiftlint:disable generic_type_name
// swiftlint:disable vertical_parameter_alignment
// MARK: - Merge methods on Publisher
extension Publisher {
/// Combines elements from this publisher with those from another publisher,
/// delivering an interleaved sequence of elements.
///
/// The merged publisher continues to emit elements until all upstream publishers
/// finish. If an upstream publisher produces an error, the merged publisher fails
/// with that error.
///
/// - Parameters:
/// - other: Another publisher.
/// - Returns: A publisher that emits an event when any upstream publisher emits
/// an event.
public func merge<
P: Publisher
>(with other: P) -> Publishers.Merge<Self, P>
where Failure == P.Failure, Output == P.Output
{
return .init(self, other)
}
/// Combines elements from this publisher with those from three other publishers,
/// delivering an interleaved sequence of elements.
///
/// The merged publisher continues to emit elements until all upstream publishers
/// finish. If an upstream publisher produces an error, the merged publisher fails
/// with that error.
///
/// - Parameters:
/// - b: A second publisher.
/// - c: A third publisher.
/// - Returns: A publisher that emits an event when any upstream publisher emits
/// an event.
public func merge<
B: Publisher,
C: Publisher
>(with b: B,
_ c: C) -> Publishers.Merge3<Self, B, C>
where Failure == B.Failure, Output == B.Output,
B.Failure == C.Failure, B.Output == C.Output
{
return .init(self, b, c)
}
/// Combines elements from this publisher with those from four other publishers,
/// delivering an interleaved sequence of elements.
///
/// The merged publisher continues to emit elements until all upstream publishers
/// finish. If an upstream publisher produces an error, the merged publisher fails
/// with that error.
///
/// - Parameters:
/// - b: A second publisher.
/// - c: A third publisher.
/// - d: A fourth publisher.
/// - Returns: A publisher that emits an event when any upstream publisher emits
/// an event.
public func merge<
B: Publisher,
C: Publisher,
D: Publisher
>(with b: B,
_ c: C,
_ d: D) -> Publishers.Merge4<Self, B, C, D>
where Failure == B.Failure, Output == B.Output,
B.Failure == C.Failure, B.Output == C.Output,
C.Failure == D.Failure, C.Output == D.Output
{
return .init(self, b, c, d)
}
/// Combines elements from this publisher with those from five other publishers,
/// delivering an interleaved sequence of elements.
///
/// The merged publisher continues to emit elements until all upstream publishers
/// finish. If an upstream publisher produces an error, the merged publisher fails
/// with that error.
///
/// - Parameters:
/// - b: A second publisher.
/// - c: A third publisher.
/// - d: A fourth publisher.
/// - e: A fifth publisher.
/// - Returns: A publisher that emits an event when any upstream publisher emits
/// an event.
public func merge<
B: Publisher,
C: Publisher,
D: Publisher,
E: Publisher
>(with b: B,
_ c: C,
_ d: D,
_ e: E) -> Publishers.Merge5<Self, B, C, D, E>
where Failure == B.Failure, Output == B.Output,
B.Failure == C.Failure, B.Output == C.Output,
C.Failure == D.Failure, C.Output == D.Output,
D.Failure == E.Failure, D.Output == E.Output
{
return .init(self, b, c, d, e)
}
/// Combines elements from this publisher with those from six other publishers,
/// delivering an interleaved sequence of elements.
///
/// The merged publisher continues to emit elements until all upstream publishers
/// finish. If an upstream publisher produces an error, the merged publisher fails
/// with that error.
///
/// - Parameters:
/// - b: A second publisher.
/// - c: A third publisher.
/// - d: A fourth publisher.
/// - e: A fifth publisher.
/// - f: A sixth publisher.
/// - Returns: A publisher that emits an event when any upstream publisher emits
/// an event.
public func merge<
B: Publisher,
C: Publisher,
D: Publisher,
E: Publisher,
F: Publisher
>(with b: B,
_ c: C,
_ d: D,
_ e: E,
_ f: F) -> Publishers.Merge6<Self, B, C, D, E, F>
where Failure == B.Failure, Output == B.Output,
B.Failure == C.Failure, B.Output == C.Output,
C.Failure == D.Failure, C.Output == D.Output,
D.Failure == E.Failure, D.Output == E.Output,
E.Failure == F.Failure, E.Output == F.Output
{
return .init(self, b, c, d, e, f)
}
/// Combines elements from this publisher with those from seven other publishers,
/// delivering an interleaved sequence of elements.
///
/// The merged publisher continues to emit elements until all upstream publishers
/// finish. If an upstream publisher produces an error, the merged publisher fails
/// with that error.
///
/// - Parameters:
/// - b: A second publisher.
/// - c: A third publisher.
/// - d: A fourth publisher.
/// - e: A fifth publisher.
/// - f: A sixth publisher.
/// - g: A seventh publisher.
/// - Returns: A publisher that emits an event when any upstream publisher emits
/// an event.
public func merge<
B: Publisher,
C: Publisher,
D: Publisher,
E: Publisher,
F: Publisher,
G: Publisher
>(with b: B,
_ c: C,
_ d: D,
_ e: E,
_ f: F,
_ g: G) -> Publishers.Merge7<Self, B, C, D, E, F, G>
where Failure == B.Failure, Output == B.Output,
B.Failure == C.Failure, B.Output == C.Output,
C.Failure == D.Failure, C.Output == D.Output,
D.Failure == E.Failure, D.Output == E.Output,
E.Failure == F.Failure, E.Output == F.Output,
F.Failure == G.Failure, F.Output == G.Output
{
return .init(self, b, c, d, e, f, g)
}
/// Combines elements from this publisher with those from eight other publishers,
/// delivering an interleaved sequence of elements.
///
/// The merged publisher continues to emit elements until all upstream publishers
/// finish. If an upstream publisher produces an error, the merged publisher fails
/// with that error.
///
/// - Parameters:
/// - b: A second publisher.
/// - c: A third publisher.
/// - d: A fourth publisher.
/// - e: A fifth publisher.
/// - f: A sixth publisher.
/// - g: A seventh publisher.
/// - h: An eighth publisher.
/// - Returns: A publisher that emits an event when any upstream publisher emits
/// an event.
public func merge<
B: Publisher,
C: Publisher,
D: Publisher,
E: Publisher,
F: Publisher,
G: Publisher,
H: Publisher
>(with b: B,
_ c: C,
_ d: D,
_ e: E,
_ f: F,
_ g: G,
_ h: H) -> Publishers.Merge8<Self, B, C, D, E, F, G, H>
where Failure == B.Failure, Output == B.Output,
B.Failure == C.Failure, B.Output == C.Output,
C.Failure == D.Failure, C.Output == D.Output,
D.Failure == E.Failure, D.Output == E.Output,
E.Failure == F.Failure, E.Output == F.Output,
F.Failure == G.Failure, F.Output == G.Output,
G.Failure == H.Failure, G.Output == H.Output
{
return .init(self, b, c, d, e, f, g, h)
}
}
extension Publisher {
/// Combines elements from this publisher with those from another publisher of
/// the same type, delivering an interleaved sequence of elements.
///
/// - Parameter other: Another publisher of this publisher's type.
/// - Returns: A publisher that emits an event when either upstream publisher emits
/// an event.
public func merge(with other: Self) -> Publishers.MergeMany<Self> {
return .init([self, other])
}
}
// MARK: - Merge publishers
extension Publishers {
/// A publisher created by applying the merge function to two upstream
/// publishers.
public struct Merge<A: Publisher,
B: Publisher>: Publisher
where A.Failure == B.Failure, A.Output == B.Output
{
public typealias Output = A.Output
public typealias Failure = A.Failure
public let a: A
public let b: B
public init(
_ a: A,
_ b: B
) {
self.a = a
self.b = b
}
public func receive<Downstream: Subscriber>(subscriber: Downstream)
where A.Failure == Downstream.Failure,
A.Output == Downstream.Input
{
typealias Merged = _Merged<Output, Failure, Downstream>
let merged = Merged(downstream: subscriber, count: 2)
a.subscribe(Merged.Side(index: 0, merger: merged))
b.subscribe(Merged.Side(index: 1, merger: merged))
subscriber.receive(subscription: merged)
}
public func merge<
P: Publisher
>(with other: P) -> Publishers.Merge3<A, B, P>
{
return .init(a, b, other)
}
public func merge<
Z: Publisher,
Y: Publisher
>(with z: Z,
_ y: Y) -> Publishers.Merge4<A, B, Z, Y>
{
return .init(a, b, z, y)
}
public func merge<
Z: Publisher,
Y: Publisher,
X: Publisher
>(with z: Z,
_ y: Y,
_ x: X) -> Publishers.Merge5<A, B, Z, Y, X>
{
return .init(a, b, z, y, x)
}
public func merge<
Z: Publisher,
Y: Publisher,
X: Publisher,
W: Publisher
>(with z: Z,
_ y: Y,
_ x: X,
_ w: W) -> Publishers.Merge6<A, B, Z, Y, X, W>
{
return .init(a, b, z, y, x, w)
}
public func merge<
Z: Publisher,
Y: Publisher,
X: Publisher,
W: Publisher,
V: Publisher
>(with z: Z,
_ y: Y,
_ x: X,
_ w: W,
_ v: V) -> Publishers.Merge7<A, B, Z, Y, X, W, V>
{
return .init(a, b, z, y, x, w, v)
}
public func merge<
Z: Publisher,
Y: Publisher,
X: Publisher,
W: Publisher,
V: Publisher,
U: Publisher
>(with z: Z,
_ y: Y,
_ x: X,
_ w: W,
_ v: V,
_ u: U) -> Publishers.Merge8<A, B, Z, Y, X, W, V, U>
{
return .init(a, b, z, y, x, w, v, u)
}
}
/// A publisher created by applying the merge function to three upstream
/// publishers.
public struct Merge3<A: Publisher,
B: Publisher,
C: Publisher>: Publisher
where A.Failure == B.Failure, A.Output == B.Output,
B.Failure == C.Failure, B.Output == C.Output
{
public typealias Output = A.Output
public typealias Failure = A.Failure
public let a: A
public let b: B
public let c: C
public init(
_ a: A,
_ b: B,
_ c: C
) {
self.a = a
self.b = b
self.c = c
}
public func receive<Downstream: Subscriber>(subscriber: Downstream)
where A.Failure == Downstream.Failure,
A.Output == Downstream.Input
{
typealias Merged = _Merged<Output, Failure, Downstream>
let merged = Merged(downstream: subscriber, count: 3)
a.subscribe(Merged.Side(index: 0, merger: merged))
b.subscribe(Merged.Side(index: 1, merger: merged))
c.subscribe(Merged.Side(index: 2, merger: merged))
subscriber.receive(subscription: merged)
}
public func merge<
P: Publisher
>(with other: P) -> Publishers.Merge4<A, B, C, P>
{
return .init(a, b, c, other)
}
public func merge<
Z: Publisher,
Y: Publisher
>(with z: Z,
_ y: Y) -> Publishers.Merge5<A, B, C, Z, Y>
{
return .init(a, b, c, z, y)
}
public func merge<
Z: Publisher,
Y: Publisher,
X: Publisher
>(with z: Z,
_ y: Y,
_ x: X) -> Publishers.Merge6<A, B, C, Z, Y, X>
{
return .init(a, b, c, z, y, x)
}
public func merge<
Z: Publisher,
Y: Publisher,
X: Publisher,
W: Publisher
>(with z: Z,
_ y: Y,
_ x: X,
_ w: W) -> Publishers.Merge7<A, B, C, Z, Y, X, W>
{
return .init(a, b, c, z, y, x, w)
}
public func merge<
Z: Publisher,
Y: Publisher,
X: Publisher,
W: Publisher,
V: Publisher
>(with z: Z,
_ y: Y,
_ x: X,
_ w: W,
_ v: V) -> Publishers.Merge8<A, B, C, Z, Y, X, W, V>
{
return .init(a, b, c, z, y, x, w, v)
}
}
/// A publisher created by applying the merge function to four upstream
/// publishers.
public struct Merge4<A: Publisher,
B: Publisher,
C: Publisher,
D: Publisher>: Publisher
where A.Failure == B.Failure, A.Output == B.Output,
B.Failure == C.Failure, B.Output == C.Output,
C.Failure == D.Failure, C.Output == D.Output
{
public typealias Output = A.Output
public typealias Failure = A.Failure
public let a: A
public let b: B
public let c: C
public let d: D
public init(
_ a: A,
_ b: B,
_ c: C,
_ d: D
) {
self.a = a
self.b = b
self.c = c
self.d = d
}
public func receive<Downstream: Subscriber>(subscriber: Downstream)
where A.Failure == Downstream.Failure,
A.Output == Downstream.Input
{
typealias Merged = _Merged<Output, Failure, Downstream>
let merged = Merged(downstream: subscriber, count: 4)
a.subscribe(Merged.Side(index: 0, merger: merged))
b.subscribe(Merged.Side(index: 1, merger: merged))
c.subscribe(Merged.Side(index: 2, merger: merged))
d.subscribe(Merged.Side(index: 3, merger: merged))
subscriber.receive(subscription: merged)
}
public func merge<
P: Publisher
>(with other: P) -> Publishers.Merge5<A, B, C, D, P>
{
return .init(a, b, c, d, other)
}
public func merge<
Z: Publisher,
Y: Publisher
>(with z: Z,
_ y: Y) -> Publishers.Merge6<A, B, C, D, Z, Y>
{
return .init(a, b, c, d, z, y)
}
public func merge<
Z: Publisher,
Y: Publisher,
X: Publisher
>(with z: Z,
_ y: Y,
_ x: X) -> Publishers.Merge7<A, B, C, D, Z, Y, X>
{
return .init(a, b, c, d, z, y, x)
}
public func merge<
Z: Publisher,
Y: Publisher,
X: Publisher,
W: Publisher
>(with z: Z,
_ y: Y,
_ x: X,
_ w: W) -> Publishers.Merge8<A, B, C, D, Z, Y, X, W>
{
return .init(a, b, c, d, z, y, x, w)
}
}
/// A publisher created by applying the merge function to five upstream
/// publishers.
public struct Merge5<A: Publisher,
B: Publisher,
C: Publisher,
D: Publisher,
E: Publisher>: Publisher
where A.Failure == B.Failure, A.Output == B.Output,
B.Failure == C.Failure, B.Output == C.Output,
C.Failure == D.Failure, C.Output == D.Output,
D.Failure == E.Failure, D.Output == E.Output
{
public typealias Output = A.Output
public typealias Failure = A.Failure
public let a: A
public let b: B
public let c: C
public let d: D
public let e: E
public init(
_ a: A,
_ b: B,
_ c: C,
_ d: D,
_ e: E
) {
self.a = a
self.b = b
self.c = c
self.d = d
self.e = e
}
public func receive<Downstream: Subscriber>(subscriber: Downstream)
where A.Failure == Downstream.Failure,
A.Output == Downstream.Input
{
typealias Merged = _Merged<Output, Failure, Downstream>
let merged = Merged(downstream: subscriber, count: 5)
a.subscribe(Merged.Side(index: 0, merger: merged))
b.subscribe(Merged.Side(index: 1, merger: merged))
c.subscribe(Merged.Side(index: 2, merger: merged))
d.subscribe(Merged.Side(index: 3, merger: merged))
e.subscribe(Merged.Side(index: 4, merger: merged))
subscriber.receive(subscription: merged)
}
public func merge<
P: Publisher
>(with other: P) -> Publishers.Merge6<A, B, C, D, E, P>
{
return .init(a, b, c, d, e, other)
}
public func merge<
Z: Publisher,
Y: Publisher
>(with z: Z,
_ y: Y) -> Publishers.Merge7<A, B, C, D, E, Z, Y>
{
return .init(a, b, c, d, e, z, y)
}
public func merge<
Z: Publisher,
Y: Publisher,
X: Publisher
>(with z: Z,
_ y: Y,
_ x: X) -> Publishers.Merge8<A, B, C, D, E, Z, Y, X>
{
return .init(a, b, c, d, e, z, y, x)
}
}
/// A publisher created by applying the merge function to six upstream
/// publishers.
public struct Merge6<A: Publisher,
B: Publisher,
C: Publisher,
D: Publisher,
E: Publisher,
F: Publisher>: Publisher
where A.Failure == B.Failure, A.Output == B.Output,
B.Failure == C.Failure, B.Output == C.Output,
C.Failure == D.Failure, C.Output == D.Output,
D.Failure == E.Failure, D.Output == E.Output,
E.Failure == F.Failure, E.Output == F.Output
{
public typealias Output = A.Output
public typealias Failure = A.Failure
public let a: A
public let b: B
public let c: C
public let d: D
public let e: E
public let f: F
public init(
_ a: A,
_ b: B,
_ c: C,
_ d: D,
_ e: E,
_ f: F
) {
self.a = a
self.b = b
self.c = c
self.d = d
self.e = e
self.f = f
}
public func receive<Downstream: Subscriber>(subscriber: Downstream)
where A.Failure == Downstream.Failure,
A.Output == Downstream.Input
{
typealias Merged = _Merged<Output, Failure, Downstream>
let merged = Merged(downstream: subscriber, count: 6)
a.subscribe(Merged.Side(index: 0, merger: merged))
b.subscribe(Merged.Side(index: 1, merger: merged))
c.subscribe(Merged.Side(index: 2, merger: merged))
d.subscribe(Merged.Side(index: 3, merger: merged))
e.subscribe(Merged.Side(index: 4, merger: merged))
f.subscribe(Merged.Side(index: 5, merger: merged))
subscriber.receive(subscription: merged)
}
public func merge<
P: Publisher
>(with other: P) -> Publishers.Merge7<A, B, C, D, E, F, P>
{
return .init(a, b, c, d, e, f, other)
}
public func merge<
Z: Publisher,
Y: Publisher
>(with z: Z,
_ y: Y) -> Publishers.Merge8<A, B, C, D, E, F, Z, Y>
{
return .init(a, b, c, d, e, f, z, y)
}
}
/// A publisher created by applying the merge function to seven upstream
/// publishers.
public struct Merge7<A: Publisher,
B: Publisher,
C: Publisher,
D: Publisher,
E: Publisher,
F: Publisher,
G: Publisher>: Publisher
where A.Failure == B.Failure, A.Output == B.Output,
B.Failure == C.Failure, B.Output == C.Output,
C.Failure == D.Failure, C.Output == D.Output,
D.Failure == E.Failure, D.Output == E.Output,
E.Failure == F.Failure, E.Output == F.Output,
F.Failure == G.Failure, F.Output == G.Output
{
public typealias Output = A.Output
public typealias Failure = A.Failure
public let a: A
public let b: B
public let c: C
public let d: D
public let e: E
public let f: F
public let g: G
public init(
_ a: A,
_ b: B,
_ c: C,
_ d: D,
_ e: E,
_ f: F,
_ g: G
) {
self.a = a
self.b = b
self.c = c
self.d = d
self.e = e
self.f = f
self.g = g
}
public func receive<Downstream: Subscriber>(subscriber: Downstream)
where A.Failure == Downstream.Failure,
A.Output == Downstream.Input
{
typealias Merged = _Merged<Output, Failure, Downstream>
let merged = Merged(downstream: subscriber, count: 7)
a.subscribe(Merged.Side(index: 0, merger: merged))
b.subscribe(Merged.Side(index: 1, merger: merged))
c.subscribe(Merged.Side(index: 2, merger: merged))
d.subscribe(Merged.Side(index: 3, merger: merged))
e.subscribe(Merged.Side(index: 4, merger: merged))
f.subscribe(Merged.Side(index: 5, merger: merged))
g.subscribe(Merged.Side(index: 6, merger: merged))
subscriber.receive(subscription: merged)
}
public func merge<
P: Publisher
>(with other: P) -> Publishers.Merge8<A, B, C, D, E, F, G, P>
{
return .init(a, b, c, d, e, f, g, other)
}
}
/// A publisher created by applying the merge function to eight upstream
/// publishers.
public struct Merge8<A: Publisher,
B: Publisher,
C: Publisher,
D: Publisher,
E: Publisher,
F: Publisher,
G: Publisher,
H: Publisher>: Publisher
where A.Failure == B.Failure, A.Output == B.Output,
B.Failure == C.Failure, B.Output == C.Output,
C.Failure == D.Failure, C.Output == D.Output,
D.Failure == E.Failure, D.Output == E.Output,
E.Failure == F.Failure, E.Output == F.Output,
F.Failure == G.Failure, F.Output == G.Output,
G.Failure == H.Failure, G.Output == H.Output
{
public typealias Output = A.Output
public typealias Failure = A.Failure
public let a: A
public let b: B
public let c: C
public let d: D
public let e: E
public let f: F
public let g: G
public let h: H
public init(
_ a: A,
_ b: B,
_ c: C,
_ d: D,
_ e: E,
_ f: F,
_ g: G,
_ h: H
) {
self.a = a
self.b = b
self.c = c
self.d = d
self.e = e
self.f = f
self.g = g
self.h = h
}
public func receive<Downstream: Subscriber>(subscriber: Downstream)
where A.Failure == Downstream.Failure,
A.Output == Downstream.Input
{
typealias Merged = _Merged<Output, Failure, Downstream>
let merged = Merged(downstream: subscriber, count: 8)
a.subscribe(Merged.Side(index: 0, merger: merged))
b.subscribe(Merged.Side(index: 1, merger: merged))
c.subscribe(Merged.Side(index: 2, merger: merged))
d.subscribe(Merged.Side(index: 3, merger: merged))
e.subscribe(Merged.Side(index: 4, merger: merged))
f.subscribe(Merged.Side(index: 5, merger: merged))
g.subscribe(Merged.Side(index: 6, merger: merged))
h.subscribe(Merged.Side(index: 7, merger: merged))
subscriber.receive(subscription: merged)
}
}
}
extension Publishers {
public struct MergeMany<Upstream: Publisher>: Publisher {
public typealias Output = Upstream.Output
public typealias Failure = Upstream.Failure
public let publishers: [Upstream]
public init(_ upstream: Upstream...) {
self.publishers = upstream
}
public init<UpstreamPublishers: Swift.Sequence>(_ upstream: UpstreamPublishers)
where Upstream == UpstreamPublishers.Element
{
publishers = Array(upstream)
}
public func receive<Downstream: Subscriber>(subscriber: Downstream)
where Upstream.Failure == Downstream.Failure,
Upstream.Output == Downstream.Input
{
typealias Merged = _Merged<Output, Failure, Downstream>
let merged = Merged(downstream: subscriber, count: publishers.count)
for (i, upstream) in publishers.enumerated() {
upstream.subscribe(Merged.Side(index: i, merger: merged))
}
subscriber.receive(subscription: merged)
}
public func merge(with other: Upstream) -> Publishers.MergeMany<Upstream> {
var newPublishers = publishers
newPublishers.append(other)
return .init(newPublishers)
}
}
}
// MARK: - Equatable conformances
extension Publishers.Merge: Equatable
where
A: Equatable,
B: Equatable {}
extension Publishers.Merge3: Equatable
where
A: Equatable,
B: Equatable,
C: Equatable {}
extension Publishers.Merge4: Equatable
where
A: Equatable,
B: Equatable,
C: Equatable,
D: Equatable {}
extension Publishers.Merge5: Equatable
where
A: Equatable,
B: Equatable,
C: Equatable,
D: Equatable,
E: Equatable {}
extension Publishers.Merge6: Equatable
where
A: Equatable,
B: Equatable,
C: Equatable,
D: Equatable,
E: Equatable,
F: Equatable {}
extension Publishers.Merge7: Equatable
where
A: Equatable,
B: Equatable,
C: Equatable,
D: Equatable,
E: Equatable,
F: Equatable,
G: Equatable {}
extension Publishers.Merge8: Equatable
where
A: Equatable,
B: Equatable,
C: Equatable,
D: Equatable,
E: Equatable,
F: Equatable,
G: Equatable,
H: Equatable {}
extension Publishers.MergeMany: Equatable
where
Upstream: Equatable {}
+5 -5
View File
@@ -7,11 +7,10 @@
/// A publisher that emits an output to each subscriber just once, and then finishes.
///
/// You can use a `Just` publisher to start a chain of publishers. A `Just` publisher is
/// also useful when replacing a value with `Publishers.Catch`.
/// You can use a `Just` publisher to start a chain of publishers. A `Just` publisher
/// is also useful when replacing a value with `Catch`.
///
/// In contrast with `Result.Publisher`, a `Just` publisher cant fail with an error.
/// And unlike `Optional.Publisher`, a `Just` publisher always produces a value.
/// In contrast with `Publishers.Once`, a `Just` publisher cannot fail with an error.
public struct Just<Output>: Publisher {
public typealias Failure = Never
@@ -293,7 +292,8 @@ extension Just {
func request(_ demand: Subscribers.Demand) {
demand.assertNonZero()
guard let downstream = self.downstream.take() else { return }
guard let downstream = self.downstream else { return }
self.downstream = nil
_ = downstream.receive(value)
downstream.receive(completion: .finished)
}
@@ -28,45 +28,28 @@ extension Optional {
self.optional = optional
}
public var publisher: Publisher {
return Publisher(optional)
}
/// The type of a Combine publisher that publishes the value of a Swift optional
/// instance to each subscriber exactly once, if the instance has any value at
/// all.
/// A publisher that publishes an optional value to each subscriber
/// exactly once, if the optional has a value.
///
/// In contrast with the `Just` publisher, which always produces a single value,
/// this publisher might not send any values and instead finish normally,
/// if `output` is `nil`.
/// In contrast with `Just`, an `Optional` publisher may send
/// no value before completion.
public struct Publisher: OpenCombine.Publisher {
/// The kind of value published by this publisher.
///
/// This publisher produces the type wrapped by the optional.
public typealias Output = Wrapped
/// The kind of error this publisher might publish.
///
/// The optional publisher never produces errors.
public typealias Failure = Never
/// The output to deliver to each subscriber.
/// The result to deliver to each subscriber.
public let output: Wrapped?
/// Creates a publisher to emit the value of the optional, or to finish
/// immediately if the optional doesn't have a value.
/// Creates a publisher to emit the optional value of a successful result,
/// or fail with an error.
///
/// - Parameter output: The result to deliver to each subscriber.
/// - Parameter result: The result to deliver to each subscriber.
public init(_ output: Output?) {
self.output = output
}
/// Implements the Publisher protocol by accepting the subscriber and
/// immediately publishing the optionals value if it has one, or finishing
/// normally if it doesnt.
///
/// - Parameter subscriber: The subscriber to add.
public func receive<Downstream: Subscriber>(subscriber: Downstream)
where Output == Downstream.Input, Failure == Downstream.Failure
{
@@ -81,23 +64,13 @@ extension Optional {
}
}
public var ocombine: OCombine {
return .init(self)
}
#if !canImport(Combine)
/// The type of a Combine publisher that publishes the value of a Swift optional
/// instance to each subscriber exactly once, if the instance has any value at
/// all.
/// A publisher that publishes an optional value to each subscriber
/// exactly once, if the optional has a value.
///
/// In contrast with the `Just` publisher, which always produces a single value,
/// this publisher might not send any values and instead finish normally,
/// if `output` is `nil`.
/// In contrast with `Just`, an `Optional` publisher may send
/// no value before completion.
public typealias Publisher = OCombine.Publisher
public var publisher: Publisher {
return Publisher(self)
}
#endif
}
@@ -122,7 +95,8 @@ extension Optional.OCombine {
func request(_ demand: Subscribers.Demand) {
demand.assertNonZero()
guard let downstream = self.downstream.take() else { return }
guard let downstream = self.downstream else { return }
self.downstream = nil
_ = downstream.receive(output)
downstream.receive(completion: .finished)
}
@@ -261,7 +235,7 @@ extension Optional.OCombine.Publisher {
in range: RangeExpression
) -> Optional<Output>.OCombine.Publisher where RangeExpression.Bound == Int {
let range = range.relative(to: 0 ..< Int.max)
precondition(range.lowerBound >= 0, "lowerBound must not be negative")
precondition(range.lowerBound >= 0, "lowerBould must not be negative")
// I don't know why, but Combine has this precondition
precondition(range.upperBound < .max - 1)
@@ -10,28 +10,13 @@ extension Publisher {
/// Publishes a single Boolean value that indicates whether all received elements pass
/// a given predicate.
///
/// Use the `allSatisfy(_:)` operator to determine if all elements in a stream satisfy
/// a criteria you provide. When this publisher receives an element, it runs
/// the predicate against the element. If the predicate returns `false`, the publisher
/// produces a `false` value and finishes. If the upstream publisher finishes
/// normally, this publisher produces a `true` value and finishes.
///
/// In the example below, the `allSatisfy(_:)` operator tests if each an integer array
/// publishers elements fall into the `targetRange`:
///
/// let targetRange = (-1...100)
/// let numbers = [-1, 0, 10, 5]
/// numbers.publisher
/// .allSatisfy { targetRange.contains($0) }
/// .sink { print("\($0)") }
///
/// // Prints: "true"
///
/// With operators similar to `reduce(_:_:)`, this publisher produces at most one
/// value.
///
/// > Note: Upon receiving any request greater than zero, this publisher requests
/// unlimited elements from the upstream publisher.
/// When this publisher receives an element, it runs the predicate against
/// the element. If the predicate returns `false`, the publisher produces a `false`
/// value and finishes. If the upstream publisher finishes normally, this publisher
/// produces a `true` value and finishes.
/// As a `reduce`-style operator, this publisher produces at most one value.
/// Backpressure note: Upon receiving any request greater than zero, this publisher
/// requests unlimited elements from the upstream publisher.
///
/// - Parameter predicate: A closure that evaluates each received element.
/// Return `true` to continue, or `false` to cancel the upstream and complete.
@@ -46,45 +31,21 @@ extension Publisher {
/// Publishes a single Boolean value that indicates whether all received elements pass
/// a given error-throwing predicate.
///
/// Use the `tryAllSatisfy(_:)` operator to determine if all elements in a stream
/// satisfy a criteria in an error-throwing predicate you provide. When this publisher
/// receives an element, it runs the predicate against the element. If the predicate
/// returns `false`, the publisher produces a `false` value and finishes.
/// If the upstream publisher finishes normally, this publisher produces a `true`
/// value and finishes. If the predicate throws an error, the publisher fails and
/// passes the error to its downstream subscriber.
/// When this publisher receives an element, it runs the predicate against
/// the element. If the predicate returns `false`, the publisher produces a `false`
/// value and finishes. If the upstream publisher finishes normally, this publisher
/// produces a `true` value and finishes. If the predicate throws an error,
/// the publisher fails, passing the error to its downstream.
/// As a `reduce`-style operator, this publisher produces at most one value.
/// Backpressure note: Upon receiving any request greater than zero, this publisher
/// requests unlimited elements from the upstream publisher.
///
/// In the example below, an error-throwing predicate tests if each of an integer
/// array publishers elements fall into the `targetRange`; the predicate throws
/// an error if an element is zero and terminates the stream.
///
/// let targetRange = (-1...100)
/// let numbers = [-1, 10, 5, 0]
///
/// numbers.publisher
/// .tryAllSatisfy { anInt in
/// guard anInt != 0 else { throw RangeError() }
/// return targetRange.contains(anInt)
/// }
/// .sink(
/// receiveCompletion: { print ("completion: \($0)") },
/// receiveValue: { print ("value: \($0)") }
/// )
///
/// // Prints: "completion: failure(RangeError())"
///
/// With operators similar to `reduce(_:_:)`, this publisher produces at most one
/// value.
///
/// > Note: Upon receiving any request greater than zero, this publisher requests
/// unlimited elements from the upstream publisher.
///
/// - Parameter predicate: A closure that evaluates each received element. Return
/// `true` to continue, or `false` to cancel the upstream and complete. The closure
/// may throw an error, in which case the publisher cancels the upstream publisher
/// and fails with the thrown error.
/// - Returns: A publisher that publishes a Boolean value that indicates whether all
/// received elements pass a given predicate.
/// - Parameter predicate: A closure that evaluates each received element.
/// Return `true` to continue, or `false` to cancel the upstream and complete.
/// The closure may throw, in which case the publisher cancels the upstream
/// publisher and fails with the thrown error.
/// - Returns: A publisher that publishes a Boolean value that indicates whether
/// all received elements pass a given predicate.
public func tryAllSatisfy(
_ predicate: @escaping (Output) throws -> Bool
) -> Publishers.TryAllSatisfy<Self> {
@@ -10,34 +10,8 @@ extension Publisher {
/// Raises a fatal error when its upstream publisher fails, and otherwise republishes
/// all received input.
///
/// Use `assertNoFailure()` for internal sanity checks that are active during testing.
/// However, it is important to note that, like its Swift counterpart
/// `fatalError(_:)`, the `assertNoFailure()` operator asserts a fatal exception when
/// triggered in both development/testing _and_ shipping versions of code.
///
/// In the example below, a `CurrentValueSubject` publishes the initial and second
/// values successfully. The third value, containing a `genericSubjectError`, causes
/// the `assertNoFailure()` operator to assert a fatal exception stopping the process:
///
/// public enum SubjectError: Error {
/// case genericSubjectError
/// }
///
/// let subject = CurrentValueSubject<String, Error>("initial value")
/// subject
/// .assertNoFailure()
/// .sink(receiveCompletion: { print ("completion: \($0)") },
/// receiveValue: { print ("value: \($0).") }
/// )
///
/// subject.send("second value")
/// subject.send(completion: .failure(SubjectError.genericSubjectError))
///
/// // Prints:
/// // value: initial value.
/// // value: second value.
/// // The process then terminates in the debugger as the assertNoFailure
/// // operator catches the genericSubjectError.
/// Use this function for internal sanity checks that are active during testing but
/// do not impact performance of shipping code.
///
/// - Parameters:
/// - prefix: A string used at the beginning of the fatal error message.
@@ -11,19 +11,13 @@ extension ConnectablePublisher {
/// publisher.
///
/// Use `autoconnect()` to simplify working with `ConnectablePublisher` instances,
/// such as `TimerPublisher` in `OpenCombineFoundation`.
/// such as those created with `makeConnectable()`.
///
/// In the following example, the `Timer.publish()` operator creates
/// a `TimerPublisher`, which is a `ConnectablePublisher`. As a result, subscribers
/// dont receive any values until after a call to `connect()`.
/// For convenience when working with a single subscriber, the `.autoconnect()`
/// operator performs the `connect()` call when attached to by the subscriber.
///
/// cancellable = Timer.publish(every: 1, on: .main, in: .default)
/// let autoconnectedPublisher = somePublisher
/// .makeConnectable()
/// .autoconnect()
/// .sink { date in
/// print ("Date now: \(date)")
/// }
/// .subscribe(someSubscriber)
///
/// - Returns: A publisher which automatically connects to its upstream connectable
/// publisher.
public func autoconnect() -> Publishers.Autoconnect<Self> {
@@ -33,12 +27,12 @@ extension ConnectablePublisher {
extension Publishers {
/// A publisher that automatically connects to an upstream connectable publisher.
///
/// This publisher calls `connect()` on the upstream `ConnectablePublisher` when first
/// attached to by a subscriber.
/// A publisher that automatically connects and disconnects from this connectable
/// publisher.
public class Autoconnect<Upstream: ConnectablePublisher>: Publisher {
// NOTE: This class has been audited for thread safety
public typealias Output = Upstream.Output
public typealias Failure = Upstream.Failure
@@ -5,8 +5,6 @@
// Created by Sergej Jaskiewicz on 03.12.2019.
//
#if !WASI
#if canImport(COpenCombineHelpers)
import COpenCombineHelpers
#endif
@@ -16,29 +14,9 @@ extension Publisher {
/// Raises a debugger signal when a provided closure needs to stop the process in
/// the debugger.
///
/// Use `breakpoint(receiveSubscription:receiveOutput:receiveCompletion:)` to examine
/// one or more stages of the subscribe/publish/completion process and stop in
/// the debugger, based on conditions you specify. When any of the provided closures
/// returns `true`, this operator raises the `SIGTRAP` signal to stop the process
/// in the debugger. Otherwise, this publisher passes through values and completions
/// as-is.
///
/// In the example below, a `PassthroughSubject` publishes strings to a breakpoint
/// republisher. When the breakpoint receives the string `DEBUGGER`, it returns
/// `true`, which stops the app in the debugger.
///
/// let publisher = PassthroughSubject<String?, Never>()
/// cancellable = publisher
/// .breakpoint(
/// receiveOutput: { value in return value == "DEBUGGER" }
/// )
/// .sink { print("\(String(describing: $0))" , terminator: " ") }
///
/// publisher.send("DEBUGGER")
///
/// // Prints: "error: Execution was interrupted, reason: signal SIGTRAP."
/// // Depending on your specific environment, the console messages may
/// // also include stack trace information, which is not shown here.
/// When any of the provided closures returns `true`, this publisher raises
/// the `SIGTRAP` signal to stop the process in the debugger.
/// Otherwise, this publisher passes through values and completions as-is.
///
/// - Parameters:
/// - receiveSubscription: A closure that executes when when the publisher receives
@@ -66,46 +44,19 @@ extension Publisher {
/// Raises a debugger signal upon receiving a failure.
///
/// When the upstream publisher fails with an error, this publisher raises
/// the `SIGTRAP` signal, which stops the process in the debugger. Otherwise, this
/// publisher passes through values and completions as-is.
///
/// In this example a `PassthroughSubject` publishes strings, but its downstream
/// `Publisher/tryMap(_:)` operator throws an error. This sends the error downstream
/// as a `Subscribers.Completion.failure(_:)`. The `breakpointOnError()`
/// operator receives this completion and stops the app in the debugger.
///
/// struct CustomError : Error {}
/// let publisher = PassthroughSubject<String?, Error>()
/// cancellable = publisher
/// .tryMap { stringValue in
/// throw CustomError()
/// }
/// .breakpointOnError()
/// .sink(
/// receiveCompletion: { completion in
/// print("Completion: \(String(describing: completion))")
/// },
/// receiveValue: { aValue in
/// print("Result: \(String(describing: aValue))")
/// }
/// )
///
/// publisher.send("TEST DATA")
///
/// // Prints: "error: Execution was interrupted, reason: signal SIGTRAP."
/// // Depending on your specific environment, the console messages may
/// // also include stack trace information, which is not shown here.
/// the `SIGTRAP` signal, which stops the process in the debugger.
/// Otherwise, this publisher passes through values and completions as-is.
///
/// - Returns: A publisher that raises a debugger signal upon receiving a failure.
public func breakpointOnError() -> Publishers.Breakpoint<Self> {
return breakpoint(receiveCompletion: { completion in
return breakpoint { completion in
switch completion {
case .finished:
return false
case .failure:
return true
}
})
}
}
}
@@ -221,11 +172,12 @@ extension Publishers.Breakpoint {
var description: String { return "Breakpoint" }
var customMirror: Mirror {
return Mirror(self, children: EmptyCollection())
let children = CollectionOfOne<Mirror.Child>(
("upstream", breakpoint.upstream)
)
return Mirror(self, children: children)
}
var playgroundDescription: Any { return description }
}
}
#endif // !WASI
@@ -1,356 +0,0 @@
//
// Publishers.Buffer.swift
//
//
// Created by Sergej Jaskiewicz on 08.01.2020.
//
extension Publisher {
/// Buffers elements received from an upstream publisher.
///
/// Use `buffer(size:prefetch:whenFull:)` to collect a specific number of elements
/// from an upstream publisher before republishing them to the downstream subscriber
/// according to the `Publishers.BufferingStrategy` and `Publishers.PrefetchStrategy`
/// strategy you specify.
///
/// If the publisher completes before reaching the `size` threshold, it buffers
/// the elements and publishes them downstream prior to completion.
///
/// - Parameters:
/// - size: The maximum number of elements to store.
/// - prefetch: The strategy to initially populate the buffer.
/// - whenFull: The action to take when the buffer becomes full.
/// - Returns: A publisher that buffers elements received from an upstream publisher.
public func buffer(
size: Int,
prefetch: Publishers.PrefetchStrategy,
whenFull: Publishers.BufferingStrategy<Failure>
) -> Publishers.Buffer<Self> {
return .init(upstream: self,
size: size,
prefetch: prefetch,
whenFull: whenFull)
}
}
extension Publishers {
/// A strategy for filling a buffer.
public enum PrefetchStrategy {
/// A strategy to fill the buffer at subscription time, and keep it full
/// thereafter.
///
/// This strategy starts by making a demand equal to the buffers size from
/// the upstream when the subscriber first connects. Afterwards, it continues
/// to demand elements from the upstream to try to keep the buffer full.
case keepFull
/// A strategy that avoids prefetching and instead performs requests on demand.
///
/// This strategy just forwards the downstreams requests to the upstream
/// publisher.
case byRequest
}
/// A strategy that handles exhaustion of a buffers capacity.
public enum BufferingStrategy<Failure: Error> {
/// When the buffer is full, discard the newly received element.
case dropNewest
/// When the buffer is full, discard the oldest element in the buffer.
case dropOldest
/// When the buffer is full, execute the closure to provide a custom error.
case customError(() -> Failure)
}
/// A publisher that buffers elements received from an upstream publisher.
public struct Buffer<Upstream: Publisher>: Publisher {
public typealias Output = Upstream.Output
public typealias Failure = Upstream.Failure
/// The publisher from which this publisher receives elements.
public let upstream: Upstream
/// The maximum number of elements to store.
public let size: Int
/// The strategy for initially populating the buffer.
public let prefetch: Publishers.PrefetchStrategy
/// The action to take when the buffer becomes full.
public let whenFull: Publishers.BufferingStrategy<Failure>
/// Creates a publisher that buffers elements received from an upstream publisher.
/// - Parameter upstream: The publisher from which this publisher receives
/// elements.
/// - Parameter size: The maximum number of elements to store.
/// - Parameter prefetch: The strategy for initially populating the buffer.
/// - Parameter whenFull: The action to take when the buffer becomes full.
public init(upstream: Upstream,
size: Int,
prefetch: Publishers.PrefetchStrategy,
whenFull: Publishers.BufferingStrategy<Failure>) {
self.upstream = upstream
self.size = size
self.prefetch = prefetch
self.whenFull = whenFull
}
public func receive<Downstream: Subscriber>(subscriber: Downstream)
where Downstream.Input == Output, Downstream.Failure == Failure
{
let inner = Inner(downstream: subscriber,
size: size,
prefetch: prefetch,
whenFull: whenFull)
upstream.subscribe(inner)
}
}
}
extension Publishers.PrefetchStrategy: Equatable {}
extension Publishers.PrefetchStrategy: Hashable {}
extension Publishers.Buffer {
private final class Inner<Downstream: Subscriber>
: Subscriber,
Subscription,
CustomStringConvertible,
CustomReflectable,
CustomPlaygroundDisplayConvertible
where Downstream.Input == Upstream.Output, Downstream.Failure == Upstream.Failure
{
typealias Input = Upstream.Output
typealias Failure = Upstream.Failure
private let lock = UnfairLock.allocate()
private var recursion = false
private let size: Int
private let prefetch: Publishers.PrefetchStrategy // keepFull is 0x0
private let whenFull: Publishers.BufferingStrategy<Failure>
private let downstream: Downstream
private var state = SubscriptionStatus.awaitingSubscription
private var downstreamDemand = Subscribers.Demand.none
// TODO: Use a deque here?
// Need to measure performance with large buffers and `dropOldest` strategy.
private var values = [Input]()
private var upstreamFailed = false
private var terminal: Subscribers.Completion<Failure>?
init(downstream: Downstream,
size: Int,
prefetch: Publishers.PrefetchStrategy,
whenFull: Publishers.BufferingStrategy<Failure>) {
self.size = size
self.prefetch = prefetch
self.whenFull = whenFull
self.downstream = downstream
}
deinit {
lock.deallocate()
}
func receive(subscription: Subscription) {
lock.lock()
guard case .awaitingSubscription = state else {
lock.unlock()
subscription.cancel()
return
}
state = .subscribed(subscription)
lock.unlock()
let upstreamDemand: Subscribers.Demand
switch prefetch {
case .keepFull:
upstreamDemand = .max(size)
case .byRequest:
upstreamDemand = .unlimited
}
subscription.request(upstreamDemand)
downstream.receive(subscription: self)
}
func receive(_ input: Input) -> Subscribers.Demand {
lock.lock()
guard case let .subscribed(subscription) = state else {
lock.unlock()
return .none
}
switch terminal {
case nil, .finished?:
if values.count >= size {
switch whenFull {
case .dropNewest:
lock.unlock()
return drain()
case .dropOldest:
values.removeFirst()
case let .customError(makeError):
terminal = .failure(makeError())
lock.unlock()
subscription.cancel()
return .none
}
}
values.append(input)
lock.unlock()
return drain()
case .failure?:
lock.unlock()
return .none
}
}
func receive(completion: Subscribers.Completion<Upstream.Failure>) {
lock.lock()
guard case .subscribed = state, terminal == nil else {
lock.unlock()
return
}
terminal = completion
lock.unlock()
_ = drain()
}
func request(_ demand: Subscribers.Demand) {
lock.lock()
guard case let .subscribed(subscription) = state else {
lock.unlock()
return
}
downstreamDemand += demand
let recursion = self.recursion
lock.unlock()
if recursion {
return
}
let more = drain()
if more != .none {
// Request the number of items just enough to fill the buffer.
subscription.request(more)
}
}
func cancel() {
lock.lock()
guard case let .subscribed(subscription) = state else {
lock.unlock()
return
}
state = .terminal
values = []
lock.unlock()
subscription.cancel()
}
private func drain() -> Subscribers.Demand {
var upstreamDemand = Subscribers.Demand.none
lock.lock()
while true {
guard case .subscribed = state else {
lock.unlock()
return upstreamDemand
}
if downstreamDemand > 0 {
if values.isEmpty {
if let completion = terminal {
state = .terminal
lock.unlock()
downstream.receive(completion: completion)
} else {
lock.unlock()
}
return upstreamDemand
}
} else {
if let completion = terminal, case .failure = completion {
state = .terminal
lock.unlock()
downstream.receive(completion: completion)
} else {
lock.unlock()
}
return upstreamDemand
}
let poppedValues = lockedPop(downstreamDemand)
assert(poppedValues.count > 0,
"""
We check that the buffer is not empty and downstreamDemand is \
nonzero, how can this be triggered?
""")
// This should not crash because `lockedPop(_:)` returns at most
// `downstreamDemand` items.
downstreamDemand -= poppedValues.count
recursion = true
lock.unlock()
var newDownstreamDemand = Subscribers.Demand.none
var additionalUpstreamDemand = 0
for value in poppedValues {
newDownstreamDemand += downstream.receive(value)
additionalUpstreamDemand += 1
}
if prefetch == .keepFull {
upstreamDemand += additionalUpstreamDemand
}
lock.lock()
recursion = false
downstreamDemand += newDownstreamDemand
}
}
private func lockedPop(_ demand: Subscribers.Demand) -> [Input] {
assert(demand > 0)
guard let max = demand.max else {
return values.take()
}
let poppedValues = Array(values.prefix(max))
values.removeFirst(poppedValues.count)
return poppedValues
}
var description: String { return "Buffer" }
var customMirror: Mirror {
let children: [Mirror.Child] = [
("values", values),
("state", state),
("downstreamDemand", downstreamDemand),
("terminal", terminal as Any)
]
return Mirror(self, children: children)
}
var playgroundDescription: Any { return description }
}
}
@@ -1,454 +0,0 @@
${template_header}
//
// Publishers.Catch.swift
//
//
// Created by Sergej Jaskiewicz on 25.12.2019.
//
%{
instantiations = ['Catch', 'TryCatch']
}%
extension Publisher {
/// Handles errors from an upstream publisher by replacing it with another publisher.
///
/// Use `catch()` to replace an error from an upstream publisher with a new publisher.
///
/// In the example below, the `catch()` operator handles the `SimpleError` thrown by
/// the upstream publisher by replacing the error with a `Just` publisher. This
/// continues the stream by publishing a single value and completing normally.
///
/// struct SimpleError: Error {}
/// let numbers = [5, 4, 3, 2, 1, 0, 9, 8, 7, 6]
/// cancellable = numbers.publisher
/// .tryLast(where: {
/// guard $0 != 0 else { throw SimpleError() }
/// return true
/// })
/// .catch { error in
/// Just(-1)
/// }
/// .sink { print("\($0)") }
/// // Prints: -1
///
/// Backpressure note: This publisher passes through `request` and `cancel` to
/// the upstream. After receiving an error, the publisher sends sends any unfulfilled
/// demand to the new `Publisher`.
///
/// - SeeAlso: `replaceError`
/// - Parameter handler: A closure that accepts the upstream failure as input and
/// returns a publisher to replace the upstream publisher.
/// - Returns: A publisher that handles errors from an upstream publisher by replacing
/// the failed publisher with another publisher.
public func `catch`<NewPublisher: Publisher>(
_ handler: @escaping (Failure) -> NewPublisher
) -> Publishers.Catch<Self, NewPublisher>
where NewPublisher.Output == Output
{
return .init(upstream: self, handler: handler)
}
/// Handles errors from an upstream publisher by either replacing it with another
/// publisher or throwing a new error.
///
/// Use `tryCatch(_:)` to decide how to handle from an upstream publisher by either
/// replacing the publisher with a new publisher, or throwing a new error.
///
/// In the example below, an array publisher emits values that a `tryMap(_:)` operator
/// evaluates to ensure the values are greater than zero. If the values arent greater
/// than zero, the operator throws an error to the downstream subscriber to let it
/// know there was a problem. The subscriber, `tryCatch(_:)`, replaces the error with
/// a new publisher using ``Just`` to publish a final value before the stream ends
/// normally.
///
/// enum SimpleError: Error { case error }
/// var numbers = [5, 4, 3, 2, 1, -1, 7, 8, 9, 10]
///
/// cancellable = numbers.publisher
/// .tryMap { v in
/// if v > 0 {
/// return v
/// } else {
/// throw SimpleError.error
/// }
/// }
/// .tryCatch { error in
/// Just(0) // Send a final value before completing normally.
/// // Alternatively, throw a new error to terminate the stream.
/// }
/// .sink(receiveCompletion: { print ("Completion: \($0).") },
/// receiveValue: { print ("Received \($0).") })
/// // Received 5.
/// // Received 4.
/// // Received 3.
/// // Received 2.
/// // Received 1.
/// // Received 0.
/// // Completion: finished.
///
/// - Parameter handler: A throwing closure that accepts the upstream failure as
/// input. This closure can either replace the upstream publisher with a new one,
/// or throw a new error to the downstream subscriber.
/// - Returns: A publisher that handles errors from an upstream publisher by replacing
/// the failed publisher with another publisher, or an error.
public func tryCatch<NewPublisher: Publisher>(
_ handler: @escaping (Failure) throws -> NewPublisher
) -> Publishers.TryCatch<Self, NewPublisher>
where NewPublisher.Output == Output
{
return .init(upstream: self, handler: handler)
}
}
extension Publishers {
/// A publisher that handles errors from an upstream publisher by replacing the failed
/// publisher with another publisher.
public struct Catch<Upstream: Publisher, NewPublisher: Publisher>: Publisher
where Upstream.Output == NewPublisher.Output
{
public typealias Output = Upstream.Output
public typealias Failure = NewPublisher.Failure
/// The publisher that this publisher receives elements from.
public let upstream: Upstream
/// A closure that accepts the upstream failure as input and returns a publisher
/// to replace the upstream publisher.
public let handler: (Upstream.Failure) -> NewPublisher
/// Creates a publisher that handles errors from an upstream publisher by
/// replacing the failed publisher with another publisher.
///
/// - Parameters:
/// - upstream: The publisher that this publisher receives elements from.
/// - handler: A closure that accepts the upstream failure as input and returns
/// a publisher to replace the upstream publisher.
public init(upstream: Upstream,
handler: @escaping (Upstream.Failure) -> NewPublisher) {
self.upstream = upstream
self.handler = handler
}
public func receive<Downstream: Subscriber>(subscriber: Downstream)
where Downstream.Input == Output, Downstream.Failure == Failure
{
let inner = Inner(downstream: subscriber, handler: handler)
let uncaughtS = Inner.UncaughtS(inner: inner)
upstream.subscribe(uncaughtS)
}
}
/// A publisher that handles errors from an upstream publisher by replacing
/// the failed publisher with another publisher or producing a new error.
///
/// Because this publishers handler can throw an error, `Publishers.TryCatch` defines
/// its `Failure` type as `Error`. This is different from `Publishers.Catch`, which
/// gets its failure type from the replacement publisher.
public struct TryCatch<Upstream: Publisher, NewPublisher: Publisher>: Publisher
where Upstream.Output == NewPublisher.Output
{
public typealias Output = Upstream.Output
public typealias Failure = Error
/// The publisher that this publisher receives elements from.
public let upstream: Upstream
/// A closure that accepts the upstream failure as input and either returns
/// a publisher to replace the upstream publisher or throws an error.
public let handler: (Upstream.Failure) throws -> NewPublisher
/// Creates a publisher that handles errors from an upstream publisher by
/// replacing the failed publisher with another publisher or by throwing an error.
///
/// - Parameters:
/// - upstream: The publisher that this publisher receives elements from.
/// - handler: A closure that accepts the upstream failure as input and either
/// returns a publisher to replace the upstream publisher. If this closure
/// throws an error, the publisher terminates with the thrown error.
public init(upstream: Upstream,
handler: @escaping (Upstream.Failure) throws -> NewPublisher) {
self.upstream = upstream
self.handler = handler
}
public func receive<Downstream: Subscriber>(subscriber: Downstream)
where Downstream.Input == Output, Downstream.Failure == Failure
{
let inner = Inner(downstream: subscriber, handler: handler)
let uncaughtS = Inner.UncaughtS(inner: inner)
upstream.subscribe(uncaughtS)
}
}
}
% for instantiation in instantiations:
% throws_modifier = ' throws' if instantiation == 'TryCatch' else ''
extension Publishers.${instantiation} {
private final class Inner<Downstream: Subscriber>
: Subscription,
CustomStringConvertible,
CustomReflectable,
CustomPlaygroundDisplayConvertible
where Downstream.Input == Upstream.Output,
% if instantiation == 'Catch':
Downstream.Failure == NewPublisher.Failure
% else:
Downstream.Failure == Error
% end
{
struct UncaughtS: Subscriber,
CustomStringConvertible,
CustomReflectable,
CustomPlaygroundDisplayConvertible
{
typealias Input = Upstream.Output
typealias Failure = Upstream.Failure
let inner: Inner
var combineIdentifier: CombineIdentifier { return inner.combineIdentifier }
func receive(subscription: Subscription) {
inner.receivePre(subscription: subscription)
}
func receive(_ input: Input) -> Subscribers.Demand {
return inner.receivePre(input)
}
func receive(completion: Subscribers.Completion<Failure>) {
return inner.receivePre(completion: completion)
}
var description: String { return inner.description }
var customMirror: Mirror { return inner.customMirror }
var playgroundDescription: Any { return description }
}
struct CaughtS: Subscriber,
CustomStringConvertible,
CustomReflectable,
CustomPlaygroundDisplayConvertible
{
typealias Input = NewPublisher.Output
typealias Failure = NewPublisher.Failure
let inner: Inner
var combineIdentifier: CombineIdentifier { return inner.combineIdentifier }
func receive(subscription: Subscription) {
inner.receivePost(subscription: subscription)
}
func receive(_ input: Input) -> Subscribers.Demand {
return inner.receivePost(input)
}
func receive(completion: Subscribers.Completion<Failure>) {
inner.receivePost(completion: completion)
}
var description: String { return inner.description }
var customMirror: Mirror { return inner.customMirror }
var playgroundDescription: Any { return description }
}
private enum State {
case pendingPre
case pre(Subscription)
case pendingPost
case post(Subscription)
case cancelled
}
private let lock = UnfairLock.allocate()
private var demand = Subscribers.Demand.none
private var state = State.pendingPre
private let downstream: Downstream
private let handler: (Upstream.Failure)${throws_modifier} -> NewPublisher
init(downstream: Downstream,
handler: @escaping (Upstream.Failure)${throws_modifier} -> NewPublisher) {
self.downstream = downstream
self.handler = handler
}
deinit {
lock.deallocate()
}
func receivePre(subscription: Subscription) {
lock.lock()
guard case .pendingPre = state else {
lock.unlock()
subscription.cancel()
return
}
state = .pre(subscription)
lock.unlock()
downstream.receive(subscription: self)
}
func receivePre(_ input: Upstream.Output) -> Subscribers.Demand {
lock.lock()
demand -= 1
lock.unlock()
let newDemand = downstream.receive(input)
lock.lock()
demand += newDemand
lock.unlock()
return newDemand
}
func receivePre(completion: Subscribers.Completion<Upstream.Failure>) {
switch completion {
case .finished:
lock.lock()
switch state {
case .pre:
state = .cancelled
lock.unlock()
downstream.receive(completion: .finished)
case .pendingPre, .pendingPost, .post, .cancelled:
lock.unlock()
}
case .failure(let error):
lock.lock()
switch state {
case .pre:
state = .pendingPost
lock.unlock()
% if instantiation == 'Catch':
handler(error).subscribe(CaughtS(inner: self))
% else:
do {
try handler(error).subscribe(CaughtS(inner: self))
} catch let anotherError {
lock.lock()
state = .cancelled
lock.unlock()
downstream.receive(completion: .failure(anotherError))
}
% end
case .cancelled:
lock.unlock()
case .pendingPre, .post, .pendingPost:
completionBeforeSubscription()
}
}
}
func receivePost(subscription: Subscription) {
lock.lock()
guard case .pendingPost = state else {
lock.unlock()
subscription.cancel()
return
}
state = .post(subscription)
let demand = self.demand
lock.unlock()
if demand > 0 {
subscription.request(demand)
}
}
func receivePost(_ input: NewPublisher.Output) -> Subscribers.Demand {
return downstream.receive(input)
}
func receivePost(completion: Subscribers.Completion<NewPublisher.Failure>) {
lock.lock()
guard case .post = state else {
lock.unlock()
return
}
state = .cancelled
lock.unlock()
% if instantiation == 'Catch':
downstream.receive(completion: completion)
% else:
downstream.receive(completion: completion.eraseError())
% end
}
func request(_ demand: Subscribers.Demand) {
demand.assertNonZero()
lock.lock()
switch state {
case .pendingPre:
// The client is only able to call the `request` method after we've sent
// `self` downstream. We only do it in the `receivePre(subscription:)`
// method, after setting `state` to `pre`.
// After that `state` never becomes `pendingPre`.
requestBeforeSubscription()
case let .pre(subscription):
self.demand += demand
lock.unlock()
subscription.request(demand)
case .pendingPost:
self.demand += demand
lock.unlock()
case let .post(subscription):
lock.unlock()
subscription.request(demand)
case .cancelled:
lock.unlock()
}
}
func cancel() {
lock.lock()
switch state {
case let .pre(subscription), let .post(subscription):
state = .cancelled
lock.unlock()
subscription.cancel()
case .pendingPre, .pendingPost, .cancelled:
lock.unlock()
}
}
var description: String { return "${instantiation}" }
var customMirror: Mirror {
let children: [Mirror.Child] = [
("downstream", downstream),
("demand", demand)
]
return Mirror(self, children: children)
}
var playgroundDescription: Any { return description }
}
}
% end
private func completionBeforeSubscription(file: StaticString = #file,
line: UInt = #line) -> Never {
fatalError("Unexpected state: received completion but do not have subscription",
file: file,
line: line)
}
private func requestBeforeSubscription(file: StaticString = #file,
line: UInt = #line) -> Never {
fatalError("Unexpected state: request before subscription sent",
file: file,
line: line)
}
@@ -10,30 +10,13 @@ extension Publisher {
/// Collects all received elements, and emits a single array of the collection when
/// the upstream publisher finishes.
///
/// Use `collect()` to gather elements into an array that the operator emits after
/// the upstream publisher finishes.
///
/// If the upstream publisher fails with an error, this publisher forwards the error
/// to the downstream receiver instead of sending its output.
///
/// This publisher requests an unlimited number of elements from the upstream
/// publisher and uses an unbounded amount of memory to store the received values.
/// The publisher may exert memory pressure on the system for very large sets of
/// elements.
///
/// The `collect()` operator only sends the collected array to its downstream receiver
/// after a request whose demand is greater than 0 items. Otherwise, `collect()` waits
/// until it receives a non-zero request.
///
/// In the example below, an Integer range is a publisher that emits an array of
/// integers:
///
/// let numbers = (0...10)
/// cancellable = numbers.publisher
/// .collect()
/// .sink { print("\($0)") }
///
/// // Prints: "[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10]"
/// publisher. It only sends the collected array to its downstream after a request
/// whose demand is greater than 0 items.
/// Note: This publisher uses an unbounded amount of memory to store the received
/// values.
///
/// - Returns: A publisher that collects all received items and returns them as
/// an array upon completion.
@@ -10,25 +10,12 @@ extension Publisher {
/// Collects up to the specified number of elements, and then emits a single array of
/// the collection.
///
/// Use `collect(_:)` to emit arrays of at most `count` elements from an upstream
/// publisher. If the upstream publisher finishes before collecting the specified
/// number of elements, the publisher sends an array of only the items it received
/// This may be fewer than `count` elements.
///
/// If the upstream publisher finishes before filling the buffer, this publisher sends
/// an array of all the items it has received. This may be fewer than `count`
/// elements.
/// If the upstream publisher fails with an error, this publisher forwards the error
/// to the downstream receiver instead of sending its output.
///
/// In the example below, the `collect(_:)` operator emits one partial and two full
/// arrays based on the requested collection size of `5`:
///
/// let numbers = (0...10)
/// cancellable = numbers.publisher
/// .collect(5)
/// .sink { print("\($0), terminator: " "") }
///
/// // Prints "[0, 1, 2, 3, 4] [5, 6, 7, 8, 9] [10] "
///
/// > Note: When this publisher receives a request for `.max(n)` elements, it requests
/// Note: When this publisher receives a request for `.max(n)` elements, it requests
/// `.max(count * n)` from the upstream publisher.
///
/// - Parameter count: The maximum number of received elements to buffer before
@@ -128,7 +115,8 @@ extension Publishers.CollectByCount {
lock.unlock()
return .none
}
let output = self.buffer.take()
let output = self.buffer
self.buffer = []
lock.unlock()
return downstream.receive(output) * count
}
@@ -142,7 +130,8 @@ extension Publishers.CollectByCount {
if buffer.isEmpty {
lock.unlock()
} else {
let buffer = self.buffer.take()
let buffer = self.buffer
self.buffer = []
lock.unlock()
_ = downstream.receive(buffer)
}
@@ -166,9 +155,10 @@ extension Publishers.CollectByCount {
func cancel() {
lock.lock()
if let subscription = self.subscription.take() {
if let subscription = self.subscription {
buffer = []
finished = true
self.subscription = nil
lock.unlock()
subscription.cancel()
} else {
@@ -7,79 +7,29 @@
extension Publisher {
/// Calls a closure with each received element and publishes any returned optional
/// that has a value.
/// Calls a closure with each received element and publishes any returned
/// optional that has a value.
///
/// OpenCombines `compactMap(_:)` operator performs a function similar to that of
/// `compactMap(_:)` in the Swift standard library: the `compactMap(_:)` operator in
/// OpenCombine removes `nil` elements in a publishers stream and republishes
/// non-`nil` elements to the downstream subscriber.
///
/// The example below uses a range of numbers as the source for a collection based
/// publisher. The `compactMap(_:)` operator consumes each element from the `numbers`
/// publisher attempting to access the dictionary using the element as the key.
/// If the examples dictionary returns a `nil`, due to a non-existent key,
/// `compactMap(_:)` filters out the `nil` (missing) elements.
///
/// let numbers = (0...5)
/// let romanNumeralDict: [Int : String] =
/// [1: "I", 2: "II", 3: "III", 5: "V"]
///
/// cancellable = numbers.publisher
/// .compactMap { romanNumeralDict[$0] }
/// .sink { print("\($0)", terminator: " ") }
///
/// // Prints: "I II III V"
///
/// - Parameter transform: A closure that receives a value and returns an optional
/// value.
/// - Returns: Any non-`nil` optional results of the calling the supplied closure.
/// - Parameter transform: A closure that receives a value and returns
/// an optional value.
/// - Returns: A publisher that republishes all non-`nil` results of calling
/// the transform closure.
public func compactMap<ElementOfResult>(
_ transform: @escaping (Output) -> ElementOfResult?
) -> Publishers.CompactMap<Self, ElementOfResult> {
return .init(upstream: self, transform: transform)
}
/// Calls an error-throwing closure with each received element and publishes any
/// returned optional that has a value.
/// Calls an error-throwing closure with each received element and publishes
/// any returned optional that has a value.
///
/// Use `tryCompactMap(_:)` to remove `nil` elements from a publishers stream based
/// on an error-throwing closure you provide. If the closure throws an error,
/// the publisher cancels the upstream publisher and sends the thrown error to
/// the downstream subscriber as a `Publisher.Failure`.
/// If the closure throws an error, the publisher cancels the upstream and sends
/// the thrown error to the downstream receiver as a `Failure`.
///
/// The following example uses an array of numbers as the source for
/// a collection-based publisher. A `tryCompactMap(_:)` operator consumes each integer
/// from the publisher and uses a dictionary to transform the numbers from its Arabic
/// to Roman numerals, as an optional `String`.
///
/// If the closure called by `tryCompactMap(_:)` fails to look up a Roman numeral,
/// it returns the optional String `(unknown)`.
///
/// If the closure called by `tryCompactMap(_:)` determines the input is `0`, it
/// throws an error. The `tryCompactMap(_:)` operator catches this error and stops
/// publishing, sending a `Subscribers.Completion.failure(_:)` that wraps the error.
///
/// struct ParseError: Error {}
/// func romanNumeral(from: Int) throws -> String? {
/// let romanNumeralDict: [Int : String] =
/// [1: "I", 2: "II", 3: "III", 4: "IV", 5: "V"]
/// guard from != 0 else { throw ParseError() }
/// return romanNumeralDict[from]
/// }
/// let numbers = [6, 5, 4, 3, 2, 1, 0]
/// cancellable = numbers.publisher
/// .tryCompactMap { try romanNumeral(from: $0) }
/// .sink(
/// receiveCompletion: { print ("\($0)") },
/// receiveValue: { print ("\($0)", terminator: " ") }
/// )
///
/// // Prints: "(Unknown) V IV III II I failure(ParseError())"
///
/// - Parameter transform: An error-throwing closure that receives a value and returns
/// an optional value.
/// - Returns: Any non-`nil` optional results of calling the supplied closure.
/// - Parameter transform: an error-throwing closure that receives a value
/// and returns an optional value.
/// - Returns: A publisher that republishes all non-`nil` results of calling
/// the `transform` closure.
public func tryCompactMap<ElementOfResult>(
_ transform: @escaping (Output) throws -> ElementOfResult?
) -> Publishers.TryCompactMap<Self, ElementOfResult> {
@@ -172,48 +122,23 @@ extension Publishers {
}
extension Publishers.CompactMap {
private struct Inner<Downstream: Subscriber>
: Subscriber,
CustomStringConvertible,
CustomReflectable,
CustomPlaygroundDisplayConvertible
where Upstream.Failure == Downstream.Failure
private final class Inner<Downstream: Subscriber>
: FilterProducer<Downstream,
Upstream.Output,
Output,
Upstream.Failure,
(Upstream.Output) -> Output?>
where Downstream.Failure == Upstream.Failure, Downstream.Input == Output
{
typealias Input = Upstream.Output
typealias Failure = Upstream.Failure
// NOTE: This class has been audited for thread safety
private let downstream: Downstream
private let filter: (Input) -> Downstream.Input?
let combineIdentifier = CombineIdentifier()
init(downstream: Downstream, filter: @escaping (Input) -> Downstream.Input?) {
self.downstream = downstream
self.filter = filter
override func receive(
newValue: Upstream.Output
) -> PartialCompletion<Output?, Downstream.Failure> {
return .continue(filter(newValue))
}
func receive(subscription: Subscription) {
downstream.receive(subscription: subscription)
}
func receive(_ input: Input) -> Subscribers.Demand {
if let output = filter(input) {
return downstream.receive(output)
}
return .max(1)
}
func receive(completion: Subscribers.Completion<Failure>) {
downstream.receive(completion: completion)
}
var description: String { return "CompactMap" }
var customMirror: Mirror {
return Mirror(self, children: EmptyCollection())
}
var playgroundDescription: Any { return description }
override var description: String { return "CompactMap" }
}
}
@@ -226,6 +151,8 @@ extension Publishers.TryCompactMap {
(Upstream.Output) throws -> Output?>
where Downstream.Failure == Error, Downstream.Input == Output
{
// NOTE: This class has been audited for thread safety
override func receive(
newValue: Upstream.Output
) -> PartialCompletion<Output?, Error> {
@@ -10,20 +10,6 @@ extension Publisher where Output: Comparable {
/// Publishes the minimum value received from the upstream publisher, after it
/// finishes.
///
/// Use `min()` to find the minimum value in a stream of elements from
/// an upstream publisher.
///
/// In the example below, the `min()` operator emits a value when the publisher
/// finishes, that value is the minimum of the values received from upstream, which
/// is `-1`.
///
/// let numbers = [-1, 0, 10, 5]
/// numbers.publisher
/// .min()
/// .sink { print("\($0)") }
///
/// // Prints: "-1"
///
/// After this publisher receives a request for more than 0 items, it requests
/// unlimited items from its upstream publisher.
///
@@ -36,20 +22,6 @@ extension Publisher where Output: Comparable {
/// Publishes the maximum value received from the upstream publisher, after it
/// finishes.
///
/// Use `max()` to determine the maximum value in the stream of elements from
/// an upstream publisher.
///
/// In the example below, the `max()` operator emits a value when the publisher
/// finishes, that value is the maximum of the values received from upstream, which
/// is `10`.
///
/// let numbers = [0, 10, 5]
/// cancellable = numbers.publisher
/// .max()
/// .sink { print("\($0)") }
///
/// // Prints: "10"
///
/// After this publisher receives a request for more than 0 items, it requests
/// unlimited items from its upstream publisher.
///
@@ -65,36 +37,11 @@ extension Publisher {
/// Publishes the minimum value received from the upstream publisher, after it
/// finishes.
///
/// Use `min(by:)` to determine the minimum value in the stream of elements from
/// an upstream publisher using a comparison operation you specify.
///
/// This operator is useful when the value received from the upstream publisher isnt
/// `Comparable`.
///
/// In the example below an array publishes enumeration elements representing playing
/// card ranks. The `min(by:)` operator compares the current and next elements using
/// the `rawValue` property of each enumeration value in the user supplied closure and
/// prints the minimum value found after publishing all of the elements.
///
/// enum Rank: Int {
/// case ace = 1, two, three, four, five, six, seven, eight, nine,
/// ten, jack, queen, king
/// }
///
/// let cards: [Rank] = [.five, .queen, .ace, .eight, .king]
/// cancellable = cards.publisher
/// .min {
/// return $0.rawValue < $1.rawValue
/// }
/// .sink { print("\($0)") }
///
/// // Prints: "ace"
///
/// After this publisher receives a request for more than 0 items, it requests
/// unlimited items from its upstream publisher.
///
/// - Parameter areInIncreasingOrder: A closure that receives two elements and returns
/// `true` if theyre in increasing order.
/// `true` if they are in increasing order.
/// - Returns: A publisher that publishes the minimum value received from the upstream
/// publisher, after the upstream publisher finishes.
public func min(
@@ -103,39 +50,15 @@ extension Publisher {
return max(by: { areInIncreasingOrder($1, $0) })
}
/// Publishes the minimum value received from the upstream publisher, using
/// the provided error-throwing closure to order the items.
///
/// Use `tryMin(by:)` to determine the minimum value of elements received from
/// the upstream publisher using an error-throwing closure you specify.
///
/// In the example below, an array publishes elements. The `tryMin(by:)` operator
/// executes the error-throwing closure that throws when the `first` element is an odd
/// number, terminating the publisher.
///
/// struct IllegalValueError: Error {}
///
/// let numbers: [Int] = [0, 10, 6, 13, 22, 22]
/// numbers.publisher
/// .tryMin { first, second -> Bool in
/// if (first % 2 != 0) {
/// throw IllegalValueError()
/// }
/// return first < second
/// }
/// .sink(
/// receiveCompletion: { print ("completion: \($0)") },
/// receiveValue: { print ("value: \($0)") }
/// )
///
/// // Prints: "completion: failure(IllegalValueError())"
/// Publishes the minimum value received from the upstream publisher, using the
/// provided error-throwing closure to order the items.
///
/// After this publisher receives a request for more than 0 items, it requests
/// unlimited items from its upstream publisher.
///
/// - Parameter areInIncreasingOrder: A throwing closure that receives two elements
/// and returns `true` if theyre in increasing order. If this closure throws,
/// the publisher terminates with a `Subscribers.Completion.failure(_:)`.
/// and returns `true` if they are in increasing order. If this closure throws, the
/// publisher terminates with a `Failure`.
/// - Returns: A publisher that publishes the minimum value received from the upstream
/// publisher, after the upstream publisher finishes.
public func tryMin(
@@ -144,36 +67,14 @@ extension Publisher {
return tryMax(by: { try areInIncreasingOrder($1, $0) })
}
/// Publishes the maximum value received from the upstream publisher, using
/// the provided ordering closure.
///
/// Use `max(by:)` to determine the maximum value of elements received from
/// the upstream publisher based on an ordering closure you specify.
///
/// In the example below, an array publishes enumeration elements representing playing
/// card ranks. The `max(by:)` operator compares the current and next elements using
/// the `rawValue` property of each enumeration value in the user supplied closure and
/// prints the maximum value found after publishing all of the elements.
///
/// enum Rank: Int {
/// case ace = 1, two, three, four, five, six, seven, eight, nine,
/// ten, jack, queen, king
/// }
///
/// let cards: [Rank] = [.five, .queen, .ace, .eight, .jack]
/// cancellable = cards.publisher
/// .max {
/// return $0.rawValue > $1.rawValue
/// }
/// .sink { print("\($0)") }
///
/// // Prints: "queen"
/// Publishes the maximum value received from the upstream publisher, using the
/// provided ordering closure.
///
/// After this publisher receives a request for more than 0 items, it requests
/// unlimited items from its upstream publisher.
///
/// - Parameter areInIncreasingOrder: A closure that receives two elements and returns
/// `true` if theyre in increasing order.
/// `true` if they are in increasing order.
/// - Returns: A publisher that publishes the maximum value received from the upstream
/// publisher, after the upstream publisher finishes.
public func max(
@@ -182,42 +83,16 @@ extension Publisher {
return .init(upstream: self, areInIncreasingOrder: areInIncreasingOrder)
}
/// Publishes the maximum value received from the upstream publisher, using
/// the provided error-throwing closure to order the items.
///
/// Use `tryMax(by:)` to determine the maximum value of elements received from
/// the upstream publisher using an error-throwing closure you specify.
///
/// In the example below, an array publishes elements. The `tryMax(by:)` operator
/// executes the error-throwing closure that throws when the `first` element is
/// an odd number, terminating the publisher.
///
/// struct IllegalValueError: Error {}
///
/// let numbers: [Int] = [0, 10, 6, 13, 22, 22]
/// cancellable = numbers.publisher
/// .tryMax { first, second -> Bool in
/// if (first % 2 != 0) {
/// throw IllegalValueError()
/// }
/// return first > second
/// }
/// .sink(
/// receiveCompletion: { print ("completion: \($0)") },
/// receiveValue: { print ("value: \($0)") }
/// )
///
/// // Prints: completion: failure(IllegalValueError())
/// Publishes the maximum value received from the upstream publisher, using the
/// provided error-throwing closure to order the items.
///
/// After this publisher receives a request for more than 0 items, it requests
/// unlimited items from its upstream publisher.
///
/// - Parameter areInIncreasingOrder: A throwing closure that receives two elements
/// and returns `true` if theyre in increasing order. If this closure throws,
/// the publisher terminates with a ``Subscribers/Completion/failure(_:)``.
///
/// and returns `true` if they are in increasing order. If this closure throws, the
/// publisher terminates with a `Failure`.
/// - Returns: A publisher that publishes the maximum value received from the upstream
/// publisher, after the upstream publisher finishes.
/// publisher, after the upstream publisher finishes.
public func tryMax(
by areInIncreasingOrder: @escaping (Output, Output) throws -> Bool
) -> Publishers.TryComparison<Self> {
@@ -7,20 +7,7 @@
extension Publisher {
/// Prefixes a publishers output with the specified values.
///
/// Use `prepend(_:)` when you need to prepend specific elements before the output
/// of a publisher.
///
/// In the example below, the `prepend(_:)` operator publishes the provided elements
/// before republishing all elements from `dataElements`:
///
/// let dataElements = (0...10)
/// cancellable = dataElements.publisher
/// .prepend(0, 1, 255)
/// .sink { print("\($0)", terminator: " ") }
///
/// // Prints: "0 1 255 0 1 2 3 4 5 6 7 8 9 10"
/// Prefixes a `Publisher`'s output with the specified sequence.
///
/// - Parameter elements: The elements to publish before this publishers elements.
/// - Returns: A publisher that prefixes the specified elements prior to this
@@ -31,21 +18,7 @@ extension Publisher {
return prepend(elements)
}
/// Prefixes a publishers output with the specified sequence.
///
/// Use `prepend(_:)` to publish values from two publishers when you need to prepend
/// one publishers elements to another.
///
/// In this example the `/prepend(_:)-v9sb` operator publishes the provided sequence
/// before republishing all elements from `dataElements`:
///
/// let prefixValues = [0, 1, 255]
/// let dataElements = (0...10)
/// cancellable = dataElements.publisher
/// .prepend(prefixValues)
/// .sink { print("\($0)", terminator: " ") }
///
/// // Prints: "0 1 255 0 1 2 3 4 5 6 7 8 9 10"
/// Prefixes a `Publisher`'s output with the specified sequence.
///
/// - Parameter elements: A sequence of elements to publish before this publishers
/// elements.
@@ -59,22 +32,10 @@ extension Publisher {
return prepend(.init(sequence: elements))
}
/// Prefixes the output of this publisher with the elements emitted by the given
/// publisher.
/// Prefixes this publishers output with the elements emitted by the given publisher.
///
/// Use `prepend(_:)` to publish values from two publishers when you need to prepend
/// one publishers elements to another.
///
/// In the example below, a publisher of `prefixValues` publishes its elements before
/// the `dataElements` publishes its elements:
///
/// let prefixValues = [0, 1, 255]
/// let dataElements = (0...10)
/// cancellable = dataElements.publisher
/// .prepend(prefixValues.publisher)
/// .sink { print("\($0)", terminator: " ") }
///
/// // Prints: "0 1 255 0 1 2 3 4 5 6 7 8 9 10"
/// The resulting publisher doesnt emit any elements until the prefixing publisher
/// finishes.
///
/// - Parameter publisher: The prefixing publisher.
/// - Returns: A publisher that prefixes the prefixing publishers elements prior to
@@ -87,51 +48,14 @@ extension Publisher {
return .init(prefix: publisher, suffix: self)
}
/// Appends a publishers output with the specified elements.
///
/// Use `append(_:)` when you need to prepend specific elements after the output of
/// a publisher.
///
/// In the example below, the `append(_:)` operator publishes the provided elements
/// after republishing all elements from `dataElements`:
///
/// let dataElements = (0...10)
/// cancellable = dataElements.publisher
/// .append(0, 1, 255)
/// .sink { print("\($0)", terminator: " ") }
///
/// // Prints: "0 1 2 3 4 5 6 7 8 9 10 0 1 255"
///
///
/// - Parameter elements: Elements to publish after this publishers elements.
/// - Returns: A publisher that appends the specifiecd elements after this publishers
/// elements.
/// Append a `Publisher`'s output with the specified sequence.
public func append(
_ elements: Output...
) -> Publishers.Concatenate<Self, Publishers.Sequence<[Output], Failure>> {
return append(elements)
}
/// Appends a publishers output with the specified sequence.
///
/// Use `append(_:)` to append a sequence to the end of
/// a publishers output.
///
/// In the example below, the `append(_:)` publisher republishes all elements from
/// `groundTransport` until it finishes, then publishes the members of `airTransport`:
///
/// let groundTransport = ["car", "bus", "truck", "subway", "bicycle"]
/// let airTransport = ["parasail", "jet", "helicopter", "rocket"]
/// cancellable = groundTransport.publisher
/// .append(airTransport)
/// .sink { print("\($0)", terminator: " ") }
///
/// // Prints: "car bus truck subway bicycle parasail jet helicopter rocket"
///
/// - Parameter elements: A sequence of elements to publish after this publishers
/// elements.
/// - Returns: A publisher that appends the sequence of elements after this
/// publishers elements.
/// Appends a `Publisher`'s output with the specified sequence.
public func append<Elements: Sequence>(
_ elements: Elements
) -> Publishers.Concatenate<Self, Publishers.Sequence<Elements, Failure>>
@@ -140,26 +64,12 @@ extension Publisher {
return append(.init(sequence: elements))
}
/// Appends the output of this publisher with the elements emitted by the given
/// publisher.
/// Appends this publishers output with the elements emitted by the given publisher.
///
/// Use `append(_:)` to append the output of one publisher to another.
/// The `append(_:)` operator produces no elements until this publisher finishes.
/// It then produces this publishers elements, followed by the given publishers
/// elements. If this publisher fails with an error, the given publishers elements
/// arent published.
///
/// In the example below, the `append` publisher republishes all elements from
/// the `numbers` publisher until it finishes, then publishes all elements from
/// the `otherNumbers` publisher:
///
/// let numbers = (0...10)
/// let otherNumbers = (25...35)
/// cancellable = numbers.publisher
/// .append(otherNumbers.publisher)
/// .sink { print("\($0)", terminator: " ") }
///
/// // Prints: "0 1 2 3 4 5 6 7 8 9 10 25 26 27 28 29 30 31 32 33 34 35 "
/// This operator produces no elements until this publisher finishes. It then produces
/// this publishers elements, followed by the given publishers elements.
/// If this publisher fails with an error, the prefixing publisher does not publish
/// the provided publishers elements.
///
/// - Parameter publisher: The appending publisher.
/// - Returns: A publisher that appends the appending publishers elements after this
@@ -175,7 +85,7 @@ extension Publisher {
extension Publishers {
/// A publisher that emits all of one publishers elements before those from another
/// A publisher that emits all of one publishers elements before those from anothe
/// publisher.
public struct Concatenate<Prefix: Publisher, Suffix: Publisher>: Publisher
where Prefix.Failure == Suffix.Failure, Prefix.Output == Suffix.Output
@@ -200,7 +110,8 @@ extension Publishers {
where Suffix.Failure == Downstream.Failure, Suffix.Output == Downstream.Input
{
let inner = Inner(downstream: subscriber, suffix: suffix)
prefix.subscribe(Inner<Downstream>.PrefixSubscriber(inner: inner))
prefix.subscribe(inner)
subscriber.receive(subscription: inner)
}
}
}
@@ -208,8 +119,9 @@ extension Publishers {
extension Publishers.Concatenate: Equatable where Prefix: Equatable, Suffix: Equatable {}
extension Publishers.Concatenate {
fileprivate final class Inner<Downstream: Subscriber>
: Subscription,
private final class Inner<Downstream: Subscriber>
: Subscriber,
Subscription,
CustomStringConvertible,
CustomReflectable,
CustomPlaygroundDisplayConvertible
@@ -219,26 +131,22 @@ extension Publishers.Concatenate {
typealias Failure = Suffix.Failure
fileprivate struct PrefixSubscriber {
let inner: Inner<Downstream>
}
fileprivate struct SuffixSubscriber {
let inner: Inner<Downstream>
}
private let downstream: Downstream
private var prefixState = SubscriptionStatus.awaitingSubscription
private let suffix: Suffix
private var suffixState = SubscriptionStatus.awaitingSubscription
private var prefixFinished = false
private var suffix: Suffix?
private var demand = Subscribers.Demand.none
private var pending = Subscribers.Demand.none
private var upstream: Subscription?
private var expectedSubscriptions = 2
private let lock = UnfairLock.allocate()
private let downstreamLock = UnfairRecursiveLock.allocate()
fileprivate init(downstream: Downstream, suffix: Suffix) {
self.downstream = downstream
self.suffix = suffix
@@ -246,13 +154,65 @@ extension Publishers.Concatenate {
deinit {
lock.deallocate()
downstreamLock.deallocate()
}
func receive(subscription: Subscription) {
lock.lock()
guard upstream == nil, expectedSubscriptions > 0 else {
lock.unlock()
subscription.cancel()
return
}
upstream = subscription
expectedSubscriptions -= 1
let demand = self.demand
lock.unlock()
if demand > 0 {
subscription.request(demand)
}
}
func receive(_ input: Input) -> Subscribers.Demand {
lock.lock()
demand -= 1
lock.unlock()
downstreamLock.lock()
let newDemand = downstream.receive(input)
downstreamLock.unlock()
lock.lock()
demand += newDemand
lock.unlock()
return newDemand
}
func receive(completion: Subscribers.Completion<Failure>) {
// Reading prefixFinished should be locked. Combine doesn't lock here.
if prefixFinished {
downstreamLock.lock()
downstream.receive(completion: completion)
downstreamLock.unlock()
return
}
guard case .finished = completion else {
downstreamLock.lock()
downstream.receive(completion: completion)
downstreamLock.unlock()
return
}
prefixFinished = true // Should be locked as well?
lock.lock()
upstream = nil
lock.unlock()
suffix.subscribe(self)
}
func request(_ demand: Subscribers.Demand) {
lock.lock()
pending += demand
guard let subscription = prefixState.subscription ?? suffixState.subscription
else {
self.demand += demand
guard let subscription = upstream else {
lock.unlock()
return
}
@@ -262,213 +222,27 @@ extension Publishers.Concatenate {
func cancel() {
lock.lock()
let upstreamSubscription =
prefixState.subscription ?? suffixState.subscription
prefixState = .terminal
suffixState = .terminal
// We MUST release the object AFTER unlocking the lock,
// since releasing it may trigger execution of arbitrary code,
// for example, if the object has a deinit.
// When the object deallocates, its deinit is called, and holding
// the lock at that moment can lead to deadlocks.
withExtendedLifetime(suffix) {
suffix = nil
guard let subscription = upstream else {
lock.unlock()
upstreamSubscription?.cancel()
return
}
upstream = nil
lock.unlock()
subscription.cancel()
}
var description: String { return "Concatenate" }
var customMirror: Mirror {
return Mirror(self, children: EmptyCollection())
let children: [Mirror.Child] = [
("downstream", downstream),
("upstreamSubscription", upstream as Any),
("suffix", suffix),
("demand", demand)
]
return Mirror(self, children: children)
}
var playgroundDescription: Any { return description }
// MARK: - Private
private func prefixReceive(subscription: Subscription) {
lock.lock()
guard case .awaitingSubscription = prefixState else {
lock.unlock()
subscription.cancel()
return
}
prefixState = .subscribed(subscription)
lock.unlock()
downstream.receive(subscription: self)
}
private func prefixReceive(_ input: Input) -> Subscribers.Demand {
lock.lock()
guard case .subscribed = prefixState, pending != .none else {
lock.unlock()
return .none
}
pending -= 1
lock.unlock()
let newDemand = downstream.receive(input)
if newDemand == .none {
return .none
}
lock.lock()
pending += newDemand
lock.unlock()
return newDemand
}
private func prefixReceive(completion: Subscribers.Completion<Failure>) {
lock.lock()
guard case .subscribed = prefixState else {
lock.unlock()
return
}
prefixState = .terminal
lock.unlock()
switch completion {
case .finished:
suffix?.subscribe(SuffixSubscriber(inner: self))
case .failure:
downstream.receive(completion: completion)
}
}
private func suffixReceive(subscription: Subscription) {
lock.lock()
guard case .awaitingSubscription = suffixState else {
lock.unlock()
subscription.cancel()
return
}
suffixState = .subscribed(subscription)
let pending = self.pending
lock.unlock()
if pending != .none {
subscription.request(pending)
}
}
private func suffixReceive(_ input: Input) -> Subscribers.Demand {
lock.lock()
guard case .subscribed = suffixState else {
lock.unlock()
return .none
}
lock.unlock()
return downstream.receive(input)
}
private func suffixReceive(completion: Subscribers.Completion<Failure>) {
lock.lock()
guard case .subscribed = suffixState else {
lock.unlock()
return
}
prefixState = .terminal
suffixState = .terminal
lock.unlock()
downstream.receive(completion: completion)
}
}
}
// MARK: - PrefixSubscriber conformances
extension Publishers.Concatenate.Inner.PrefixSubscriber: Subscriber {
fileprivate typealias Input = Suffix.Output
fileprivate typealias Failure = Suffix.Failure
fileprivate var combineIdentifier: CombineIdentifier {
return inner.combineIdentifier
}
fileprivate func receive(subscription: Subscription) {
inner.prefixReceive(subscription: subscription)
}
fileprivate func receive(_ input: Input) -> Subscribers.Demand {
return inner.prefixReceive(input)
}
fileprivate func receive(completion: Subscribers.Completion<Failure>) {
inner.prefixReceive(completion: completion)
}
}
extension Publishers.Concatenate.Inner.PrefixSubscriber
: CustomStringConvertible
{
fileprivate var description: String {
return inner.description
}
}
extension Publishers.Concatenate.Inner.PrefixSubscriber
: CustomReflectable
{
fileprivate var customMirror: Mirror {
return inner.customMirror
}
}
extension Publishers.Concatenate.Inner.PrefixSubscriber
: CustomPlaygroundDisplayConvertible
{
fileprivate var playgroundDescription: Any {
return inner.playgroundDescription
}
}
// MARK: - SuffixSubscriber conformances
extension Publishers.Concatenate.Inner.SuffixSubscriber: Subscriber {
fileprivate typealias Input = Suffix.Output
fileprivate typealias Failure = Suffix.Failure
fileprivate var combineIdentifier: CombineIdentifier {
return inner.combineIdentifier
}
fileprivate func receive(subscription: Subscription) {
inner.suffixReceive(subscription: subscription)
}
fileprivate func receive(_ input: Input) -> Subscribers.Demand {
return inner.suffixReceive(input)
}
fileprivate func receive(completion: Subscribers.Completion<Failure>) {
inner.suffixReceive(completion: completion)
}
}
extension Publishers.Concatenate.Inner.SuffixSubscriber
: CustomStringConvertible
{
fileprivate var description: String {
return inner.description
}
}
extension Publishers.Concatenate.Inner.SuffixSubscriber
: CustomReflectable
{
fileprivate var customMirror: Mirror {
return inner.customMirror
}
}
extension Publishers.Concatenate.Inner.SuffixSubscriber
: CustomPlaygroundDisplayConvertible
{
fileprivate var playgroundDescription: Any {
return inner.playgroundDescription
}
}
@@ -9,22 +9,10 @@ extension Publisher where Output: Equatable {
/// Publishes a Boolean value upon receiving an element equal to the argument.
///
/// Use `contains(_:)` to find the first element in an upstream thats equal to
/// the supplied argument. The `Publishers.Contains` publisher consumes all received
/// elements until the upstream publisher produces a matching element. Upon finding
/// the first match, it emits `true` and finishes normally. If the upstream finishes
/// normally without producing a matching element, this publisher emits `false` and
/// finishes.
///
/// In the example below, the `contains(_:)` operator emits `true` the first time it
/// receives the value `5` from the `numbers.publisher`, and then finishes normally.
///
/// let numbers = [-1, 5, 10, 5]
/// numbers.publisher
/// .contains(5)
/// .sink { print("\($0)") }
///
/// // Prints: "true"
/// The contains publisher consumes all received elements until the upstream publisher
/// produces a matching element. At that point, it emits `true` and finishes normally.
/// If the upstream finishes normally without producing a matching element,
/// this publisher emits `false`, then finishes.
///
/// - Parameter output: An element to match against.
/// - Returns: A publisher that emits the Boolean value `true` when the upstream
@@ -39,27 +27,12 @@ extension Publisher {
/// Publishes a Boolean value upon receiving an element that satisfies the predicate
/// closure.
///
/// Use `contains(where:)` to find the first element in an upstream that satisfies
/// the closure you provide. This operator consumes elements produced from
/// the upstream publisher until the upstream publisher produces a matching element.
///
/// This operator is useful when the upstream publisher produces elements that dont
/// conform to `Equatable`.
///
/// In the example below, the `contains(where:)` operator tests elements against
/// the supplied closure and emits `true` for the first elements thats greater than
/// `4`, and then finishes normally.
///
/// let numbers = [-1, 0, 10, 5]
/// numbers.publisher
/// .contains {$0 > 4}
/// .sink { print("\($0)") }
///
/// // Prints: "true"
/// This operator consumes elements produced from the upstream publisher until
/// the upstream publisher produces a matching element.
///
/// - Parameter predicate: A closure that takes an element as its parameter and
/// returns a Boolean value that indicates whether the element satisfies
/// the closures comparison logic.
/// returns a Boolean value indicating whether the element satisfies the closures
/// comparison logic.
/// - Returns: A publisher that emits the Boolean value `true` when the upstream
/// publisher emits a matching value.
public func contains(
@@ -68,47 +41,16 @@ extension Publisher {
return .init(upstream: self, predicate: predicate)
}
/// Publishes a Boolean value upon receiving an element that satisfies the throwing
/// predicate closure.
///
/// Use `tryContains(where:)` to find the first element in an upstream that satisfies
/// the error-throwing closure you provide.
/// Publishes a Boolean value upon receiving an element that satisfies
/// the throwing predicate closure.
///
/// This operator consumes elements produced from the upstream publisher until
/// the upstream publisher either:
///
/// - Produces a matching element, after which it emits `true` and the publisher
/// finishes normally.
/// - Emits `false` if no matching element is found and the publisher finishes
/// normally.
///
/// If the predicate throws an error, the publisher fails, passing the error to its
/// downstream.
///
/// In the example below, the `tryContains(where:)` operator tests values to find
/// an element less than `10`; when the closure finds an odd number, like `3`,
/// the publisher terminates with an `IllegalValueError`.
///
/// struct IllegalValueError: Error {}
///
/// let numbers = [3, 2, 10, 5, 0, 9]
/// numbers.publisher
/// .tryContains {
/// if ($0 % 2 != 0) {
/// throw IllegalValueError()
/// }
/// return $0 < 10
/// }
/// .sink(
/// receiveCompletion: { print ("completion: \($0)") },
/// receiveValue: { print ("value: \($0)") }
/// )
///
/// // Prints: "completion: failure(IllegalValueError())"
/// the upstream publisher produces a matching element. If the closure throws,
/// the stream fails with an error.
///
/// - Parameter predicate: A closure that takes an element as its parameter and
/// returns a Boolean value that indicates whether the element satisfies
/// the closures comparison logic.
/// returns a Boolean value indicating whether the element satisfies the closures
/// comparison logic.
/// - Returns: A publisher that emits the Boolean value `true` when the upstream
/// publisher emits a matching value.
public func tryContains(
@@ -9,18 +9,8 @@ extension Publisher {
/// Publishes the number of elements received from the upstream publisher.
///
/// Use `count(`` to determine the number of elements received from the upstream
/// publisher before it completes:
///
/// let numbers = (0...10)
/// cancellable = numbers.publisher
/// .count()
/// .sink { print("\($0)") }
///
/// // Prints: "11"
///
/// - Returns: A publisher that consumes all elements until the upstream publisher
/// finishes, then emits a single value with the total number of elements received.
/// finishes, then emits a single value with the total number of elements received.
public func count() -> Publishers.Count<Self> {
return Publishers.Count(upstream: self)
}
@@ -1,332 +0,0 @@
//
// Publishers.Debounce.swift
//
//
// Created by Sergej Jaskiewicz on 17.12.2019.
//
extension Publisher {
/// Publishes elements only after a specified time interval elapses between events.
///
/// Use the `debounce(for:scheduler:options:)` operator to control the number of
/// values and time between delivery of values from the upstream publisher. This
/// operator is useful to process bursty or high-volume event streams where you need
/// to reduce the number of values delivered to the downstream to a rate you specify.
///
/// In this example, a `PassthroughSubject` publishes elements on a schedule defined
/// by the `bounces` array. The array is composed of tuples representing a value sent
/// by the `PassthroughSubject`, and a `TimeInterval` ranging from one-quarter second
/// up to 2 seconds that drives a delivery timer. As the queue builds, elements
/// arriving faster than one-half second `debounceInterval` are discarded, while
/// elements arriving at a rate slower than `debounceInterval` are passed through to
/// the `sink(receiveValue:)` operator.
///
/// let bounces:[(Int,TimeInterval)] = [
/// (0, 0),
/// (1, 0.25), // 0.25s interval since last index
/// (2, 1), // 0.75s interval since last index
/// (3, 1.25), // 0.25s interval since last index
/// (4, 1.5), // 0.25s interval since last index
/// (5, 2) // 0.5s interval since last index
/// ]
///
/// let subject = PassthroughSubject<Int, Never>()
/// cancellable = subject
/// .debounce(for: .seconds(0.5), scheduler: RunLoop.main)
/// .sink { index in
/// print ("Received index \(index)")
/// }
///
/// for bounce in bounces {
/// DispatchQueue.main.asyncAfter(deadline: .now() + bounce.1) {
/// subject.send(bounce.0)
/// }
/// }
///
/// // Prints:
/// // Received index 1
/// // Received index 4
/// // Received index 5
///
/// // Here is the event flow shown from the perspective of time, showing value
/// // delivery through the `debounce()` operator:
///
/// // Time 0: Send index 0.
/// // Time 0.25: Send index 1. Index 0 was waiting and is discarded.
/// // Time 0.75: Debounce period ends, publish index 1.
/// // Time 1: Send index 2.
/// // Time 1.25: Send index 3. Index 2 was waiting and is discarded.
/// // Time 1.5: Send index 4. Index 3 was waiting and is discarded.
/// // Time 2: Debounce period ends, publish index 4. Also, send index 5.
/// // Time 2.5: Debounce period ends, publish index 5.
///
/// - Parameters:
/// - dueTime: The time the publisher should wait before publishing an element.
/// - scheduler: The scheduler on which this publisher delivers elements
/// - options: Scheduler options that customize this publishers delivery
/// of elements.
/// - Returns: A publisher that publishes events only after a specified time elapses.
public func debounce<Context: Scheduler>(
for dueTime: Context.SchedulerTimeType.Stride,
scheduler: Context,
options: Context.SchedulerOptions? = nil
) -> Publishers.Debounce<Self, Context> {
return .init(upstream: self,
dueTime: dueTime,
scheduler: scheduler,
options: options)
}
}
extension Publishers {
/// A publisher that publishes elements only after a specified time interval elapses
/// between events.
public struct Debounce<Upstream: Publisher, Context: Scheduler>: Publisher {
public typealias Output = Upstream.Output
public typealias Failure = Upstream.Failure
/// The publisher from which this publisher receives elements.
public let upstream: Upstream
/// The amount of time the publisher should wait before publishing an element.
public let dueTime: Context.SchedulerTimeType.Stride
/// The scheduler on which this publisher delivers elements.
public let scheduler: Context
/// Scheduler options that customize this publishers delivery of elements.
public let options: Context.SchedulerOptions?
public init(upstream: Upstream,
dueTime: Context.SchedulerTimeType.Stride,
scheduler: Context,
options: Context.SchedulerOptions?) {
self.upstream = upstream
self.dueTime = dueTime
self.scheduler = scheduler
self.options = options
}
public func receive<Downstream: Subscriber>(subscriber: Downstream)
where Downstream.Failure == Failure, Downstream.Input == Output
{
let inner = Inner(downstream: subscriber,
dueTime: dueTime,
scheduler: scheduler,
options: options)
upstream.subscribe(inner)
}
}
}
extension Publishers.Debounce {
private final class Inner<Downstream: Subscriber>
: Subscriber,
Subscription,
CustomStringConvertible,
CustomReflectable,
CustomPlaygroundDisplayConvertible
where Upstream.Output == Downstream.Input,
Upstream.Failure == Downstream.Failure
{
typealias Input = Upstream.Output
typealias Failure = Upstream.Failure
private typealias Generation = UInt64
private enum CancellerState {
case pending
case active(Cancellable)
fileprivate func cancel() {
if case let .active(cancellable) = self {
cancellable.cancel()
}
}
}
private let lock = UnfairLock.allocate()
private let downstreamLock = UnfairRecursiveLock.allocate()
private let downstream: Downstream
private let dueTime: Context.SchedulerTimeType.Stride
private let scheduler: Context
private let options: Context.SchedulerOptions?
private var state = SubscriptionStatus.awaitingSubscription
private var currentCancellers = [Generation : CancellerState]()
private var currentValue: Output?
private var currentGeneration: Generation = 0
private var downstreamDemand = Subscribers.Demand.none
init(downstream: Downstream,
dueTime: Context.SchedulerTimeType.Stride,
scheduler: Context,
options: Context.SchedulerOptions?) {
self.downstream = downstream
self.dueTime = dueTime
self.scheduler = scheduler
self.options = options
}
deinit {
lock.deallocate()
downstreamLock.deallocate()
}
func receive(subscription: Subscription) {
lock.lock()
guard case .awaitingSubscription = state else {
lock.unlock()
subscription.cancel()
return
}
state = .subscribed(subscription)
lock.unlock()
downstreamLock.lock()
downstream.receive(subscription: self)
downstreamLock.unlock()
subscription.request(.unlimited)
}
func receive(_ input: Input) -> Subscribers.Demand {
lock.lock()
guard case .subscribed = state else {
lock.unlock()
return .none
}
currentGeneration += 1
let generation = currentGeneration
currentValue = input
let due = scheduler.now.advanced(by: dueTime)
let previousCancellers = self.currentCancellers.take()
currentCancellers[generation] = .pending
lock.unlock()
let newCanceller = scheduler.schedule(after: due,
interval: dueTime,
tolerance: scheduler.minimumTolerance,
options: options) {
self.due(generation: generation)
}
lock.lock()
currentCancellers[generation] = .active(newCanceller)
lock.unlock()
for canceller in previousCancellers.values {
canceller.cancel()
}
return .none
}
func receive(completion: Subscribers.Completion<Failure>) {
lock.lock()
guard case .subscribed = state else {
lock.unlock()
return
}
state = .terminal
let previousCancellers = currentCancellers.take()
lock.unlock()
for canceller in previousCancellers.values {
canceller.cancel()
}
scheduler.schedule {
self.downstreamLock.lock()
self.downstream.receive(completion: completion)
self.downstreamLock.unlock()
}
}
func request(_ demand: Subscribers.Demand) {
lock.lock()
guard case .subscribed = state else {
lock.unlock()
return
}
downstreamDemand += demand
lock.unlock()
}
func cancel() {
lock.lock()
guard case .subscribed(let subscription) = state else {
lock.unlock()
return
}
state = .terminal
let previousCancellers = currentCancellers.take()
lock.unlock()
for canceller in previousCancellers.values {
canceller.cancel()
}
subscription.cancel()
}
var description: String { return "Debounce" }
var customMirror: Mirror {
let children: [Mirror.Child] = [
("downstream", downstream),
("downstreamDemand", downstreamDemand),
("currentValue", currentValue as Any)
]
return Mirror(self, children: children)
}
var playgroundDescription: Any { return description }
private func due(generation: Generation) {
lock.lock()
guard case .subscribed = state else {
lock.unlock()
return
}
// If this condition holds, it means that no values were received
// in this time frame => we should propagate the current value downstream.
guard generation == currentGeneration, let value = currentValue else {
let canceller = currentCancellers[generation]
lock.unlock()
canceller?.cancel()
return
}
guard let canceller = currentCancellers[generation].take() else {
lock.unlock()
return
}
let hasAnyDemand = downstreamDemand != .none
if hasAnyDemand {
downstreamDemand -= 1
}
lock.unlock()
canceller.cancel()
guard hasAnyDemand else { return }
downstreamLock.lock()
let newDemand = downstream.receive(value)
downstreamLock.unlock()
if newDemand == .none { return }
lock.lock()
downstreamDemand += newDemand
lock.unlock()
}
}
}
@@ -7,52 +7,8 @@
extension Publisher {
/// Delays delivery of all output to the downstream receiver by a specified amount of
/// time on a particular scheduler.
///
/// Use `delay(for:tolerance:scheduler:options:)` when you need to delay the delivery
/// of elements to a downstream by a specified amount of time.
///
/// In this example, a `Timer` publishes an event every second.
/// The `delay(for:tolerance:scheduler:options:)` operator holds the delivery of
/// the initial element for 3 seconds (±0.5 seconds), after which each element is
/// delivered to the downstream on the main run loop after the specified delay:
///
/// let df = DateFormatter()
/// df.dateStyle = .none
/// df.timeStyle = .long
/// cancellable = Timer.publish(every: 1.0, on: .main, in: .default)
/// .autoconnect()
/// .handleEvents(receiveOutput: { date in
/// print ("Sending Timestamp \'\(df.string(from: date))\' to delay()")
/// })
/// .delay(for: .seconds(3), scheduler: RunLoop.main, options: .none)
/// .sink(
/// receiveCompletion: { print ("completion: \($0)", terminator: "\n") },
/// receiveValue: { value in
/// let now = Date()
/// print("""
/// At \(df.string(from: now)) received Timestamp \
/// \'\(df.string(from: value))\' \
/// sent: \(String(format: "%.2f", now.timeIntervalSince(value)))
/// secs ago
/// """)
/// }
/// )
///
/// // Prints:
/// // Sending Timestamp '5:02:33 PM PDT' to delay()
/// // Sending Timestamp '5:02:34 PM PDT' to delay()
/// // Sending Timestamp '5:02:35 PM PDT' to delay()
/// // Sending Timestamp '5:02:36 PM PDT' to delay()
/// // At 5:02:36 PM PDT received Timestamp '5:02:33 PM PDT' sent: 3.00
/// // secs ago
/// // Sending Timestamp '5:02:37 PM PDT' to delay()
/// // At 5:02:37 PM PDT received Timestamp '5:02:34 PM PDT' sent: 3.00
/// // secs ago
/// // Sending Timestamp '5:02:38 PM PDT' to delay()
/// // At 5:02:38 PM PDT received Timestamp '5:02:35 PM PDT' sent: 3.00
/// // secs ago
/// Delays delivery of all output to the downstream receiver by a specified amount
/// of time on a particular scheduler.
///
/// The delay affects the delivery of elements and completion, but not of the original
/// subscription.
@@ -61,7 +17,6 @@ extension Publisher {
/// - interval: The amount of time to delay.
/// - tolerance: The allowed tolerance in firing delayed events.
/// - scheduler: The scheduler to deliver the delayed events.
/// - options: Options relevant to the schedulers behavior.
/// - Returns: A publisher that delays delivery of elements and completion to
/// the downstream receiver.
public func delay<Context: Scheduler>(
@@ -119,12 +74,7 @@ extension Publishers {
where Upstream.Failure == Downstream.Failure,
Upstream.Output == Downstream.Input
{
let inner = Inner(downstream: subscriber,
interval: interval,
tolerance: tolerance,
scheduler: scheduler,
options: options)
upstream.subscribe(inner)
upstream.subscribe(Inner(self, downstream: subscriber))
}
}
}
@@ -135,28 +85,25 @@ extension Publishers.Delay {
Subscription
where Downstream.Input == Upstream.Output, Downstream.Failure == Upstream.Failure
{
// NOTE: This class has been audited for thread safety
typealias Input = Upstream.Output
typealias Failure = Upstream.Failure
fileprivate typealias Delay = Publishers.Delay<Upstream, Context>
private enum State {
case ready(Delay, Downstream)
case subscribed(Delay, Downstream, Subscription)
case terminal
}
private let lock = UnfairLock.allocate()
private let downstream: Downstream
private let interval: Context.SchedulerTimeType.Stride
private let tolerance: Context.SchedulerTimeType.Stride
private let scheduler: Context
private let options: Context.SchedulerOptions?
private var state = SubscriptionStatus.awaitingSubscription
private var state: State
private let downstreamLock = UnfairRecursiveLock.allocate()
fileprivate init(downstream: Downstream,
interval: Context.SchedulerTimeType.Stride,
tolerance: Context.SchedulerTimeType.Stride,
scheduler: Context,
options: Context.SchedulerOptions?) {
self.downstream = downstream
self.interval = interval
self.tolerance = tolerance
self.scheduler = scheduler
self.options = options
fileprivate init(_ publisher: Delay, downstream: Downstream) {
state = .ready(publisher, downstream)
}
deinit {
@@ -164,82 +111,73 @@ extension Publishers.Delay {
downstreamLock.deallocate()
}
private func schedule(_ work: @escaping () -> Void) {
scheduler
.schedule(after: scheduler.now.advanced(by: interval),
tolerance: tolerance,
options: options,
private func schedule(_ delay: Delay, work: @escaping () -> Void) {
delay
.scheduler
.schedule(after: delay.scheduler.now.advanced(by: delay.interval),
tolerance: delay.tolerance,
options: delay.options,
work)
}
func receive(subscription: Subscription) {
lock.lock()
guard case .awaitingSubscription = state else {
guard case let .ready(delay, downstream) = state else {
lock.unlock()
subscription.cancel()
return
}
state = .subscribed(subscription)
state = .subscribed(delay, downstream, subscription)
lock.unlock()
downstreamLock.lock()
downstream.receive(subscription: self)
downstreamLock.unlock()
}
func receive(_ input: Input) -> Subscribers.Demand {
func receive(_ input: Upstream.Output) -> Subscribers.Demand {
lock.lock()
guard case .subscribed = state else {
guard case let .subscribed(delay, downstream, _) = state else {
lock.unlock()
return .none
}
lock.unlock()
schedule {
self.scheduledReceive(input)
schedule(delay) {
self.scheduledReceive(input, downstream: downstream)
}
return .none
}
private func scheduledReceive(_ input: Input) {
private func scheduledReceive(_ input: Upstream.Output, downstream: Downstream) {
downstreamLock.lock()
let newDemand = downstream.receive(input)
downstreamLock.unlock()
guard newDemand > 0 else {
return
}
lock.lock()
guard state.subscription != nil else {
guard case let .subscribed(_, _, subscription) = state else {
lock.unlock()
return
}
lock.unlock()
downstreamLock.lock()
let newDemand = downstream.receive(input)
downstreamLock.unlock()
if newDemand == .none { return }
lock.lock()
let subscription = state.subscription
lock.unlock()
subscription?.request(newDemand)
subscription.request(newDemand)
}
func receive(completion: Subscribers.Completion<Failure>) {
lock.lock()
guard case let .subscribed(subscription) = state else {
lock.unlock()
return
}
state = .pendingTerminal(subscription)
lock.unlock()
schedule {
self.scheduledReceive(completion: completion)
}
}
private func scheduledReceive(completion: Subscribers.Completion<Failure>) {
lock.lock()
guard case .pendingTerminal = state else {
assertionFailure(
"This branch should not be reachable! Please report a bug."
)
guard case let .subscribed(delay, downstream, _) = state else {
lock.unlock()
return
}
state = .terminal
lock.unlock()
schedule(delay) {
self.scheduledReceive(completion: completion, downstream: downstream)
}
}
private func scheduledReceive(completion: Subscribers.Completion<Failure>,
downstream: Downstream) {
downstreamLock.lock()
downstream.receive(completion: completion)
downstreamLock.unlock()
@@ -247,7 +185,7 @@ extension Publishers.Delay {
func request(_ demand: Subscribers.Demand) {
lock.lock()
guard case let .subscribed(subscription) = state else {
guard case let .subscribed(_, _, subscription) = state else {
lock.unlock()
return
}
@@ -257,7 +195,7 @@ extension Publishers.Delay {
func cancel() {
lock.lock()
guard case let .subscribed(subscription) = state else {
guard case let .subscribed(_, _, subscription) = state else {
lock.unlock()
return
}
@@ -8,20 +8,8 @@
extension Publisher {
/// Omits the specified number of elements before republishing subsequent elements.
///
/// Use `dropFirst(_:)` when you want to drop the first `n` elements from the upstream
/// publisher, and republish the remaining elements.
///
/// The example below drops the first five elements from the stream:
///
/// let numbers = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
/// cancellable = numbers.publisher
/// .dropFirst(5)
/// .sink { print("\($0)", terminator: " ") }
///
/// // Prints: "6 7 8 9 10 "
///
/// - Parameter count: The number of elements to omit. The default is `1`.
/// - Returns: A publisher that doesnt republish the first `count` elements.
/// - Parameter count: The number of elements to omit.
/// - Returns: A publisher that does not republish the first `count` elements.
public func dropFirst(_ count: Int = 1) -> Publishers.Drop<Self> {
return .init(upstream: self, count: count)
}
@@ -52,8 +40,8 @@ extension Publishers {
Upstream.Output == Downstream.Input
{
let inner = Inner(downstream: subscriber, count: count)
subscriber.receive(subscription: inner)
upstream.subscribe(inner)
subscriber.receive(subscription: inner)
}
}
}
@@ -70,6 +58,8 @@ extension Publishers.Drop {
where Upstream.Output == Downstream.Input,
Upstream.Failure == Downstream.Failure
{
// NOTE: This class has been audited for thread safety.
typealias Input = Upstream.Output
typealias Failure = Upstream.Failure
@@ -104,7 +94,7 @@ extension Publishers.Drop {
precondition(count >= 0, "count must not be negative")
let demandToRequestFromUpstream = pendingDemand + count
lock.unlock()
if demandToRequestFromUpstream != .none {
if demandToRequestFromUpstream > 0 {
subscription.request(demandToRequestFromUpstream)
}
}
@@ -119,9 +109,8 @@ extension Publishers.Drop {
}
func receive(completion: Subscribers.Completion<Upstream.Failure>) {
lock.lock()
// Combine doesn't lock here!
subscription = nil
lock.unlock()
downstream.receive(completion: completion)
}
@@ -138,10 +127,9 @@ extension Publishers.Drop {
}
func cancel() {
lock.lock()
let subscription = self.subscription.take()
lock.unlock()
// Combine doesn't lock here!
subscription?.cancel()
subscription = nil
}
var description: String { return "Drop" }
@@ -10,39 +10,20 @@ extension Publisher {
/// Ignores elements from the upstream publisher until it receives an element from
/// a second publisher.
///
/// Use `drop(untilOutputFrom:)` to ignore elements from the upstream publisher until
/// another, second, publisher delivers its first element.
/// This publisher requests a single value from the second publisher, and it ignores
/// (drops) all elements from the upstream publisher until the second publisher
/// produces a value. After the second publisher produces an element,
/// `drop(untilOutputFrom:)` cancels its subscription to the second publisher, and
/// allows events from the upstream publisher to pass through.
///
/// This publisher requests a single value from the upstream publisher, and it ignores
/// (drops) all elements from that publisher until the upstream publisher produces
/// a value. After the `other` publisher produces an element, this publisher cancels
/// its subscription to the `other` publisher, and allows events from the `upstream`
/// publisher to pass through.
/// After this publisher receives a subscription from the upstream publisher, it
/// passes through backpressure requests from downstream to the upstream publisher.
/// If the upstream publisher acts on those requests before the other publisher
/// produces an item, this publisher drops the elements it receives from the upstream
/// publisher.
///
/// In the example below, the `pub1` publisher defers publishing its elements until
/// the `pub2` publisher delivers its first element:
///
/// let upstream = PassthroughSubject<Int, Never>()
/// let second = PassthroughSubject<String, Never>()
/// cancellable = upstream
/// .drop(untilOutputFrom: second)
/// .sink { print("\($0)", terminator: " ") }
///
/// upstream.send(1)
/// upstream.send(2)
/// second.send("A")
/// upstream.send(3)
/// upstream.send(4)
/// // Prints "3 4"
///
/// - Parameter publisher: A publisher to monitor for its first emitted element.
/// - Returns: A publisher that drops elements from the upstream publisher until
/// the `other` publisher produces a value.
/// - Returns: A publisher that drops elements from the upstream publisher until the
/// `other` publisher produces a value.
public func drop<Other: Publisher>(
untilOutputFrom publisher: Other
) -> Publishers.DropUntilOutput<Self, Other> where Failure == Other.Failure {
@@ -84,9 +65,9 @@ extension Publishers {
Other.Failure == Downstream.Failure
{
let inner = Inner(downstream: subscriber)
subscriber.receive(subscription: inner)
other.subscribe(Inner.OtherSubscriber(inner: inner))
upstream.subscribe(inner)
subscriber.receive(subscription: inner)
}
}
}
@@ -204,7 +185,8 @@ extension Publishers.DropUntilOutput {
}
otherFinished = true
if let upstreamSubscription = self.upstreamSubscription.take() {
if let upstreamSubscription = self.upstreamSubscription {
self.upstreamSubscription = nil
lock.unlock()
upstreamSubscription.cancel()
} else {
@@ -228,8 +210,10 @@ extension Publishers.DropUntilOutput {
func cancel() {
lock.lock()
let upstreamSubscription = self.upstreamSubscription.take()
let otherSubscription = self.otherSubscription.take()
let upstreamSubscription = self.upstreamSubscription
let otherSubscription = self.otherSubscription
self.upstreamSubscription = nil
self.otherSubscription = nil
cancelled = true
lock.unlock()
@@ -10,21 +10,6 @@ extension Publisher {
/// Omits elements from the upstream publisher until a given closure returns false,
/// before republishing all remaining elements.
///
/// Use `drop(while:)` to omit elements from an upstream publisher until the element
/// received meets a condition you specify.
///
/// In the example below, the operator omits all elements in the stream until
/// the first element arrives thats a positive integer, after which the operator
/// publishes all remaining elements:
///
/// let numbers = [-62, -1, 0, 10, 0, 22, 41, -1, 5]
/// cancellable = numbers.publisher
/// .drop { $0 <= 0 }
/// .sink { print("\($0)") }
///
/// // Prints: "10 0 22 41 -1 5"
///
///
/// - Parameter predicate: A closure that takes an element as a parameter and returns
/// a Boolean value indicating whether to drop the element from the publishers
/// output.
@@ -39,33 +24,7 @@ extension Publisher {
/// Omits elements from the upstream publisher until an error-throwing closure returns
/// false, before republishing all remaining elements.
///
/// Use `Publisher/tryDrop(while:)` to omit elements from an upstream until
/// an error-throwing closure you provide returns false, after which the remaining
/// items in the stream are published. If the closure throws, no elements are emitted
/// and the publisher fails with an error.
///
/// In the example below, elements are ignored until `-1` is encountered in the stream
/// and the closure returns `false`. The publisher then republishes the remaining
/// elements and finishes normally. Conversely, if the `guard` value in the closure
/// had been encountered, the closure would throw and the publisher would fail with
/// an error.
///
/// struct RangeError: Error {}
/// var numbers = [1, 2, 3, 4, 5, 6, -1, 7, 8, 9, 10]
/// let range: CountableClosedRange<Int> = (1...100)
/// cancellable = numbers.publisher
/// .tryDrop {
/// guard $0 != 0 else { throw RangeError() }
/// return range.contains($0)
/// }
/// .sink(
/// receiveCompletion: { print ("completion: \($0)") },
/// receiveValue: { print ("value: \($0)") }
/// )
///
/// // Prints: "-1 7 8 9 10 completion: finished"
/// // If instead numbers was [1, 2, 3, 4, 5, 6, 0, -1, 7, 8, 9, 10],
/// // tryDrop(while:) would fail with a RangeError.
/// If the predicate closure throws, the publisher fails with an error.
///
/// - Parameter predicate: A closure that takes an element as a parameter and returns
/// a Boolean value indicating whether to drop the element from the publishers
@@ -11,100 +11,16 @@ instantiations = ['Encode', 'Decode']
}%
extension Publisher {
/// Encodes the output from upstream using a specified encoder.
///
/// Use `encode(encoder:)` with a `JSONDecoder` (or a `PropertyListDecoder` for
/// property lists) to encode an `Encodable` struct into `Data` that could be used to
/// make a JSON string (or written to disk as a binary plist in the case of property
/// lists).
///
/// In this example, a `PassthroughSubject` publishes an `Article`.
/// The `encode(encoder:)` operator encodes the properties of the `Article` struct
/// into a new JSON string according to the `Codable` protocol adopted by `Article`.
/// The operator publishes the resulting JSON string to the downstream subscriber.
/// If the encoding operation fails, which can happen in the case of complex
/// properties that cant be directly transformed into JSON, the stream terminates
/// and the error is passed to the downstream subscriber.
///
/// struct Article: Codable {
/// let title: String
/// let author: String
/// let pubDate: Date
/// }
///
/// let dataProvider = PassthroughSubject<Article, Never>()
/// let cancellable = dataProvider
/// .encode(encoder: JSONEncoder())
/// .sink(receiveCompletion: { print ("Completion: \($0)") },
/// receiveValue: { data in
/// guard let stringRepresentation =
/// String(data: data, encoding: .utf8) else { return }
/// print("""
/// Data received \(data) string representation: \
/// \(stringRepresentation)
/// """)
/// })
///
/// dataProvider.send(Article(title: "My First Article",
/// author: "Gita Kumar",
/// pubDate: Date()))
///
/// // Prints: "Data received 86 bytes string representation:
/// // {"title":"My First Article","author":"Gita Kumar"
/// // "pubDate":606211803.279603}"
///
/// - Parameter encoder: An encoder that implements the `TopLevelEncoder` protocol.
/// - Returns: A publisher that encodes received elements using a specified encoder,
/// and publishes the resulting data.
/// Encodes the output from upstream using a specified `TopLevelEncoder`.
/// For example, use `JSONEncoder`.
public func encode<Coder: TopLevelEncoder>(
encoder: Coder
) -> Publishers.Encode<Self, Coder> {
return .init(upstream: self, encoder: encoder)
}
/// Decodes the output from the upstream using a specified decoder.
///
/// Use `decode(type:decoder:)` with a `JSONDecoder` (or a `PropertyListDecoder` for
/// property lists) to decode data received from a `URLSession.DataTaskPublisher` or
/// other data source using the `Decodable` protocol.
///
/// In this example, a `PassthroughSubject` publishes a JSON string. The JSON decoder
/// parses the string, converting its fields according to the `Decodable` protocol
/// implemented by `Article`, and successfully populating a new `Article`.
/// The `Publishers.Decode` publisher then publishes the `Article` to the downstream.
/// If a decoding operation fails, which happens in the case of missing or malformed
/// data in the source JSON string, the stream terminates and passes the error to
/// the downstream subscriber.
///
/// struct Article: Codable {
/// let title: String
/// let author: String
/// let pubDate: Date
/// }
///
/// let dataProvider = PassthroughSubject<Data, Never>()
/// cancellable = dataProvider
/// .decode(type: Article.self, decoder: JSONDecoder())
/// .sink(receiveCompletion: { print ("Completion: \($0)")},
/// receiveValue: { print ("value: \($0)") })
///
/// dataProvider.send(Data("""
/// {\"pubDate\":1574273638.575666, \
/// \"title\" : \"My First Article\", \
/// \"author\" : \"Gita Kumar\" }
/// """.utf8))
///
/// // Prints:
/// // ".sink() data received Article(title: "My First Article",
/// // author: "Gita Kumar",
/// // pubDate: 2050-11-20 18:13:58 +0000)"
///
/// - Parameters:
/// - type: The encoded data to decode into a struct that conforms to
/// the `Decodable` protocol.
/// - decoder: A decoder that implements the `TopLevelDecoder` protocol.
/// - Returns: A publisher that decodes a given type using a specified decoder and
/// publishes the result.
/// Decodes the output from upstream using a specified `TopLevelDecoder`.
/// For example, use `JSONDecoder`.
public func decode<Item: Decodable, Coder: TopLevelDecoder>(
type: Item.Type,
decoder: Coder
@@ -171,6 +87,9 @@ extension Publishers.${instantiation} {
CustomPlaygroundDisplayConvertible
where Downstream.Input == Output, Downstream.Failure == Error
{
// NOTE: This class has been audited for thread safety.
// Combine doesn't use any locking here.
typealias Input = Upstream.Output
typealias Failure = Upstream.Failure
@@ -179,8 +98,6 @@ extension Publishers.${instantiation} {
private let ${instantiation.lower()}: (Upstream.Output) throws -> Output
private let lock = UnfairLock.allocate()
private var finished = false
private var subscription: Subscription?
@@ -193,70 +110,44 @@ extension Publishers.${instantiation} {
self.${instantiation.lower()} = ${instantiation.lower()}
}
deinit {
lock.deallocate()
}
func receive(subscription: Subscription) {
lock.lock()
if finished || self.subscription != nil {
lock.unlock()
subscription.cancel()
return
}
self.subscription = subscription
lock.unlock()
downstream.receive(subscription: self)
}
func receive(_ input: Input) -> Subscribers.Demand {
lock.lock()
if finished {
lock.unlock()
return .none
}
lock.unlock()
if finished { return .none }
do {
return try downstream.receive(${instantiation.lower()}(input))
} catch {
lock.lock()
finished = true
let subscription = self.subscription.take()
lock.unlock()
subscription?.cancel()
subscription = nil
downstream.receive(completion: .failure(error))
return .none
}
}
func receive(completion: Subscribers.Completion<Failure>) {
lock.lock()
if finished {
lock.unlock()
return
}
if finished { return }
finished = true
subscription = nil
lock.unlock()
downstream.receive(completion: completion.eraseError())
}
func request(_ demand: Subscribers.Demand) {
lock.lock()
let subscription = self.subscription
lock.unlock()
subscription?.request(demand)
}
func cancel() {
lock.lock()
guard !finished, let subscription = self.subscription.take() else {
lock.unlock()
return
}
finished = true
lock.unlock()
guard let subscription = self.subscription, !finished else { return }
subscription.cancel()
self.subscription = nil
finished = true
}
var description: String { return "${instantiation}" }
@@ -9,20 +9,6 @@ extension Publisher {
/// Republishes all elements that match a provided closure.
///
/// OpenCombines `filter(_:)` operator performs an operation similar to that of
/// `filter(_:)` in the Swift Standard Library: it uses a closure to test each element
/// to determine whether to republish the element to the downstream subscriber.
///
/// The following example, uses a filter operation that receives an `Int` and only
/// republishes a value if its even.
///
/// let numbers: [Int] = [1, 2, 3, 4, 5]
/// cancellable = numbers.publisher
/// .filter { $0 % 2 == 0 }
/// .sink { print("\($0)", terminator: " ") }
///
/// // Prints: "2 4"
///
/// - Parameter isIncluded: A closure that takes one element and returns
/// a Boolean value indicating whether to republish the element.
/// - Returns: A publisher that republishes all elements that satisfy the closure.
@@ -34,34 +20,11 @@ extension Publisher {
/// Republishes all elements that match a provided error-throwing closure.
///
/// Use `tryFilter(_:)` to filter elements evaluated in an error-throwing closure.
/// If the `isIncluded` closure throws an error, the publisher fails with that error.
///
/// In the example below, `tryFilter(_:)` checks to see if the divisor provided by
/// the publisher is zero, and throws a `DivisionByZeroError` and then terminates
/// the publisher with the thrown error:
///
/// struct DivisionByZeroError: Error {}
///
/// let numbers: [Int] = [1, 2, 3, 4, 0, 5]
/// cancellable = numbers.publisher
/// .tryFilter {
/// if $0 == 0 {
/// throw DivisionByZeroError()
/// } else {
/// return $0 % 2 == 0
/// }
/// }
/// .sink(
/// receiveCompletion: { print ("\($0)") },
/// receiveValue: { print ("\($0)", terminator: " ") }
/// )
///
/// // Prints: "2 4 failure(DivisionByZeroError())".
///
/// - Parameter isIncluded: A closure that takes one element and returns a Boolean
/// value that indicated whether to republish the element or throws an error.
/// - Returns: A publisher that republishes all elements that satisfy the closure.
/// - Parameter isIncluded: A closure that takes one element and returns a
/// Boolean value indicating whether to republish the element.
/// - Returns: A publisher that republishes all elements that satisfy the closure.
public func tryFilter(
_ isIncluded: @escaping (Output) throws -> Bool
) -> Publishers.TryFilter<Self> {
@@ -179,48 +142,23 @@ extension Publishers {
}
extension Publishers.Filter {
private struct Inner<Downstream: Subscriber>
: Subscriber,
CustomStringConvertible,
CustomReflectable,
CustomPlaygroundDisplayConvertible
private final class Inner<Downstream: Subscriber>
: FilterProducer<Downstream,
Upstream.Output,
Upstream.Output,
Upstream.Failure,
(Upstream.Output) -> Bool>
where Upstream.Output == Downstream.Input, Upstream.Failure == Downstream.Failure
{
typealias Input = Upstream.Output
typealias Failure = Upstream.Failure
// NOTE: This class has been audited for thread safety
private let downstream: Downstream
private let filter: (Input) -> Bool
let combineIdentifier = CombineIdentifier()
init(downstream: Downstream, filter: @escaping (Input) -> Bool) {
self.downstream = downstream
self.filter = filter
override func receive(
newValue: Upstream.Output
) -> PartialCompletion<Upstream.Output?, Downstream.Failure> {
return filter(newValue) ? .continue(newValue) : .continue(nil)
}
func receive(subscription: Subscription) {
downstream.receive(subscription: subscription)
}
func receive(_ input: Input) -> Subscribers.Demand {
if filter(input) {
return downstream.receive(input)
}
return .max(1)
}
func receive(completion: Subscribers.Completion<Failure>) {
downstream.receive(completion: completion)
}
var description: String { return "Filter" }
var customMirror: Mirror {
return Mirror(self, children: EmptyCollection())
}
var playgroundDescription: Any { return description }
override var description: String { return "Filter" }
}
}
@@ -233,6 +171,8 @@ extension Publishers.TryFilter {
(Upstream.Output) throws -> Bool>
where Downstream.Input == Upstream.Output, Downstream.Failure == Error
{
// NOTE: This class has been audited for thread safety
override func receive(
newValue: Upstream.Output
) -> PartialCompletion<Upstream.Output?, Error> {
@@ -9,89 +9,38 @@ extension Publisher {
/// Publishes the first element of a stream, then finishes.
///
/// Use `first()` to publish just the first element from an upstream publisher, then
/// finish normally. The `first()` operator requests `Subscribers.Demand.unlimited`
/// from its upstream as soon as downstream requests at least one element.
/// If the upstream completes before `first()` receives any elements, it completes
/// without emitting any values.
///
/// In this example, the `first()` publisher republishes the first element received
/// from the sequence publisher, `-10`, then finishes normally.
///
/// let numbers = (-10...10)
/// cancellable = numbers.publisher
/// .first()
/// .sink { print("\($0)") }
///
/// // Print: "-10"
///
/// If this publisher doesnt receive any elements, it finishes without publishing.
/// - Returns: A publisher that only publishes the first element of a stream.
public func first() -> Publishers.First<Self> {
return .init(upstream: self)
}
/// Publishes the first element of a stream to satisfy a predicate closure, then
/// finishes normally.
/// Publishes the first element of a stream to
/// satisfy a predicate closure, then finishes.
///
/// Use `first(where:)` to republish only the first element of a stream that satisfies
/// a closure you specify. The publisher ignores all elements after the first element
/// that satisfies the closure and finishes normally.
/// If this publisher doesnt receive any elements, it finishes without publishing.
///
/// In the example below, the provided closure causes the `Publishers.FirstWhere`
/// publisher to republish the first received element thats greater than `0`,
/// then finishes normally.
///
/// let numbers = (-10...10)
/// cancellable = numbers.publisher
/// .first { $0 > 0 }
/// .sink { print("\($0)") }
///
/// // Prints: "1"
///
/// - Parameter predicate: A closure that takes an element as a parameter and returns
/// a Boolean value that indicates whether to publish the element.
/// - Returns: A publisher that only publishes the first element of a stream that
/// satisfies the predicate.
/// The publisher ignores all elements after the first.
/// If this publisher doesnt receive any elements,
/// it finishes without publishing.
/// - Parameter predicate: A closure that takes an element as a parameter and
/// returns a Boolean value that indicates whether to publish the element.
/// - Returns: A publisher that only publishes the first element of a stream
/// that satifies the predicate.
public func first(
where predicate: @escaping (Output) -> Bool
) -> Publishers.FirstWhere<Self> {
return .init(upstream: self, predicate: predicate)
}
/// Publishes the first element of a stream to satisfy a throwing predicate closure,
/// then finishes normally.
/// Publishes the first element of a stream to satisfy a
/// throwing predicate closure, then finishes.
///
/// Use `tryFirst(where:)` when you need to republish only the first element of
/// a stream that satisfies an error-throwing closure you specify.
/// The publisher ignores all elements after the first. If this publisher doesnt
/// receive any elements, it finishes without publishing. If the predicate closure
/// throws an error, the publisher fails.
///
/// In the example below, a range publisher emits the first element in the range then
/// finishes normally:
///
/// let numberRange: ClosedRange<Int> = (-1...50)
/// numberRange.publisher
/// .tryFirst {
/// guard $0 < 99 else {throw RangeError()}
/// return true
/// }
/// .sink(
/// receiveCompletion: { print ("completion: \($0)", terminator: " ") },
/// receiveValue: { print ("\($0)", terminator: " ") }
/// )
///
/// // Prints: "-1 completion: finished"
/// // If instead the number range were ClosedRange<Int> = (100...200),
/// // the tryFirst operator would terminate publishing with a RangeError.
///
/// - Parameter predicate: A closure that takes an element as a parameter and returns
/// a Boolean value that indicates whether to publish the element.
/// - Returns: A publisher that only publishes the first element of a stream that
/// satisfies the predicate.
/// The publisher ignores all elements after the first. If this publisher
/// doesnt receive any elements, it finishes without publishing. If the
/// predicate closure throws, the publisher fails with an error.
/// - Parameter predicate: A closure that takes an element as a parameter and
/// returns a Boolean value that indicates whether to publish the element.
/// - Returns: A publisher that only publishes the first element of a stream
/// that satifies the predicate.
public func tryFirst(
where predicate: @escaping (Output) throws -> Bool
) -> Publishers.TryFirstWhere<Self> {
@@ -5,57 +5,16 @@
//
extension Publisher {
/// Transforms all elements from an upstream publisher into a new publisher up to
/// a maximum number of publishers you specify.
/// Transforms all elements from an upstream publisher into a new or existing
/// publisher.
///
/// OpenCombines `flatMap(maxPublishers:_:)` operator performs a similar function
/// to the `flatMap(_:)` operator in the Swift standard library, but turns
/// the elements from one kind of publisher into a new publisher that is sent
/// to subscribers. Use `flatMap(maxPublishers:_:)` when you want to create a new
/// series of events for downstream subscribers based on the received value.
/// The closure creates the new `Publisher` based on the received value.
/// The new `Publisher` can emit more than one event, and successful completion of
/// the new `Publisher` does not complete the overall stream.
/// Failure of the new `Publisher` will fail the overall stream.
///
/// In the example below, a `PassthroughSubject` publishes `WeatherStation` elements.
/// The `flatMap(maxPublishers:_:)` receives each element, creates a `URL` from it,
/// and produces a new `URLSession.DataTaskPublisher`, which will publish the data
/// loaded from that `URL`.
///
/// public struct WeatherStation {
/// public let stationID: String
/// }
///
/// var weatherPublisher = PassthroughSubject<WeatherStation, URLError>()
///
/// cancellable = weatherPublisher
/// .flatMap { station -> URLSession.DataTaskPublisher in
/// let url = URL(string: """
/// https://weatherapi.example.com/stations/\(station.stationID)\
/// /observations/latest
/// """)!
/// return URLSession.shared.dataTaskPublisher(for: url)
/// }
/// .sink(
/// receiveCompletion: { completion in
/// // Handle publisher completion (normal or error).
/// },
/// receiveValue: {
/// // Process the received data.
/// }
/// )
///
/// weatherPublisher.send(WeatherStation(stationID: "KSFO")) // San Francisco, CA
/// weatherPublisher.send(WeatherStation(stationID: "EGLC")) // London, UK
/// weatherPublisher.send(WeatherStation(stationID: "ZBBB")) // Beijing, CN
/// `flatMap` merges the output from all returned publishers into a single stream of
/// output.
///
/// - Parameters:
/// - maxPublishers: Specifies the maximum number of concurrent publisher
/// subscriptions, or `Subscribers.Demand.unlimited` if unspecified.
/// - transform: A closure that takes an element as a parameter and returns
/// a publisher that produces elements of that type.
/// - maxPublishers: The maximum number of publishers produced by this method.
/// - transform: A closure that takes an element as a parameter and returns a
/// publisher that produces elements of that type.
/// - Returns: A publisher that transforms elements from an upstream publisher into
/// a publisher of that elements type.
public func flatMap<Result, Child: Publisher>(
@@ -69,72 +28,7 @@ extension Publisher {
}
}
extension Publisher where Failure == Never {
/// Transforms all elements from an upstream publisher into a new publisher up to
/// a maximum number of publishers you specify.
///
/// - Parameters:
/// - maxPublishers: Specifies the maximum number of concurrent publisher
/// subscriptions, or `Subscribers.Demand.unlimited` if unspecified.
/// - transform: A closure that takes an element as a parameter and returns
/// a publisher that produces elements of that type.
/// - Returns: A publisher that transforms elements from an upstream publisher into
/// a publisher of that elements type.
public func flatMap<Child: Publisher>(
maxPublishers: Subscribers.Demand = .unlimited,
_ transform: @escaping (Output) -> Child
) -> Publishers.FlatMap<Child, Publishers.SetFailureType<Self, Child.Failure>> {
return setFailureType(to: Child.Failure.self)
.flatMap(maxPublishers: maxPublishers, transform)
}
/// Transforms all elements from an upstream publisher into a new publisher up to
/// a maximum number of publishers you specify.
///
/// - Parameters:
/// - maxPublishers: Specifies the maximum number of concurrent publisher
/// subscriptions, or `Subscribers.Demand.unlimited` if unspecified.
/// - transform: A closure that takes an element as a parameter and returns
/// a publisher that produces elements of that type.
/// - Returns: A publisher that transforms elements from an upstream publisher
/// into a publisher of that elements type.
public func flatMap<Child: Publisher>(
maxPublishers: Subscribers.Demand = .unlimited,
_ transform: @escaping (Output) -> Child
) -> Publishers.FlatMap<Child, Self> where Child.Failure == Never {
return .init(upstream: self, maxPublishers: maxPublishers, transform: transform)
}
}
extension Publisher {
/// Transforms all elements from an upstream publisher into a new publisher up to
/// a maximum number of publishers you specify.
///
/// - Parameters:
/// - maxPublishers: Specifies the maximum number of concurrent publisher
/// subscriptions, or `Subscribers.Demand.unlimited` if unspecified.
/// - transform: A closure that takes an element as a parameter and returns
/// a publisher that produces elements of that type.
/// - Returns: A publisher that transforms elements from an upstream publisher into
/// a publisher of that elements type.
public func flatMap<Child: Publisher>(
maxPublishers: Subscribers.Demand = .unlimited,
_ transform: @escaping (Output) -> Child
) -> Publishers.FlatMap<Publishers.SetFailureType<Child, Failure>, Self>
where Child.Failure == Never
{
return flatMap(maxPublishers: maxPublishers) {
transform($0).setFailureType(to: Failure.self)
}
}
}
extension Publishers {
/// A publisher that transforms elements from an upstream publisher into a new
/// publisher.
public struct FlatMap<Child: Publisher, Upstream: Publisher>: Publisher
where Child.Failure == Upstream.Failure
{
@@ -157,17 +51,17 @@ extension Publishers {
public func receive<Downstream: Subscriber>(subscriber: Downstream)
where Child.Output == Downstream.Input, Upstream.Failure == Downstream.Failure
{
let outer = Outer(downstream: subscriber,
let inner = Inner(downstream: subscriber,
maxPublishers: maxPublishers,
map: transform)
subscriber.receive(subscription: outer)
upstream.subscribe(outer)
subscriber.receive(subscription: inner)
upstream.subscribe(inner)
}
}
}
extension Publishers.FlatMap {
private final class Outer<Downstream: Subscriber>
private final class Inner<Downstream: Subscriber>
: Subscriber,
Subscription,
CustomStringConvertible,
@@ -184,8 +78,9 @@ extension Publishers.FlatMap {
/// acquired.
private var outerSubscription: Subscription?
// Must be recursive lock. Probably a bug in Combine.
/// The lock for requesting from `outerSubscription`.
private let outerLock = UnfairRecursiveLock.allocate()
private let outerLock = UnfairLock.allocate()
/// The lock for modifying the state. All mutable state here should be
/// read and modified with this lock acquired.
@@ -243,7 +138,7 @@ extension Publishers.FlatMap {
subscription.request(maxPublishers)
}
fileprivate func receive(_ input: Input) -> Subscribers.Demand {
fileprivate func receive(_ input: Upstream.Output) -> Subscribers.Demand {
lock.lock()
let cancelledOrCompleted = self.cancelledOrCompleted
lock.unlock()
@@ -260,9 +155,9 @@ extension Publishers.FlatMap {
return .none
}
fileprivate func receive(completion: Subscribers.Completion<Failure>) {
lock.lock()
fileprivate func receive(completion: Subscribers.Completion<Child.Failure>) {
outerSubscription = nil
lock.lock()
outerFinished = true
switch completion {
case .finished:
@@ -272,8 +167,6 @@ extension Publishers.FlatMap {
let wasAlreadyCancelledOrCompleted = cancelledOrCompleted
cancelledOrCompleted = true
for (_, subscription) in subscriptions {
// Cancelling subscriptions with the lock acquired. Not good,
// but that's what Combine does. This code path is tested.
subscription.cancel()
}
subscriptions = [:]
@@ -304,7 +197,8 @@ extension Publishers.FlatMap {
}
if demand == .unlimited {
downstreamDemand = .unlimited
let buffer = self.buffer.take()
let buffer = self.buffer
self.buffer = []
let subscriptions = self.subscriptions
lock.unlock()
downstreamLock.lock()
@@ -355,19 +249,16 @@ extension Publishers.FlatMap {
fileprivate func cancel() {
lock.lock()
if cancelledOrCompleted {
lock.unlock()
return
}
cancelledOrCompleted = true
let subscriptions = self.subscriptions.take()
let outerSubscription = self.outerSubscription.take()
let subscriptions = self.subscriptions
self.subscriptions = [:]
lock.unlock()
for (_, subscription) in subscriptions {
subscription.cancel()
}
// Combine doesn't acquire outerLock here. Weird.
// Combine doesn't acquire the lock here. Weird.
outerSubscription?.cancel()
outerSubscription = nil
}
// MARK: - Reflection
@@ -447,7 +338,8 @@ extension Publishers.FlatMap {
return
}
cancelledOrCompleted = true
let subscriptions = self.subscriptions.take()
let subscriptions = self.subscriptions
self.subscriptions = [:]
lock.unlock()
for (i, subscription) in subscriptions where i != index {
subscription.cancel()
@@ -474,9 +366,9 @@ extension Publishers.FlatMap {
private func releaseLockThenSendCompletionDownstreamIfNeeded(
outerFinished: Bool
) -> Bool {
#if DEBUG
#if DEBUG
lock.assertOwner() // Sanity check
#endif
#endif
if !cancelledOrCompleted && outerFinished && buffer.isEmpty &&
subscriptions.count + pendingSubscriptions == 0 {
cancelledOrCompleted = true
@@ -498,10 +390,10 @@ extension Publishers.FlatMap {
CustomReflectable,
CustomPlaygroundDisplayConvertible {
private let index: SubscriptionIndex
private let inner: Outer
private let inner: Inner
fileprivate let combineIdentifier = CombineIdentifier()
fileprivate init(index: SubscriptionIndex, inner: Outer) {
fileprivate init(index: SubscriptionIndex, inner: Inner) {
self.index = index
self.inner = inner
}
@@ -9,35 +9,6 @@ extension Publisher {
/// Performs the specified closures when publisher events occur.
///
/// Use `handleEvents` when you want to examine elements as they progress through
/// the stages of the publishers lifecycle.
///
/// In the example below, a publisher of integers shows the effect of printing
/// debugging information at each stage of the element-processing lifecycle:
///
/// let integers = (0...2)
/// cancellable = integers.publisher
/// .handleEvents(receiveSubscription: { subs in
/// print("Subscription: \(subs.combineIdentifier)")
/// }, receiveOutput: { anInt in
/// print("in output handler, received \(anInt)")
/// }, receiveCompletion: { _ in
/// print("in completion handler")
/// }, receiveCancel: {
/// print("received cancel")
/// }, receiveRequest: { (demand) in
/// print("received demand: \(demand.description)")
/// })
/// .sink { _ in return }
///
/// // Prints:
/// // received demand: unlimited
/// // Subscription: 0x7f81284734c0
/// // in output handler, received 0
/// // in output handler, received 1
/// // in output handler, received 2
/// // in completion handler
///
/// - Parameters:
/// - receiveSubscription: A closure that executes when the publisher receives
/// the subscription from the upstream publisher. Defaults to `nil`.
@@ -120,6 +91,7 @@ extension Publishers {
Upstream.Output == Downstream.Input
{
let inner = Inner(self, downstream: subscriber)
subscriber.receive(subscription: inner)
upstream.subscribe(inner)
}
}
@@ -138,21 +110,13 @@ extension Publishers.HandleEvents {
typealias Failure = Upstream.Failure
private var status = SubscriptionStatus.awaitingSubscription
private var pendingDemand = Subscribers.Demand.none
private let lock = UnfairLock.allocate()
public var receiveSubscription: ((Subscription) -> Void)?
public var receiveOutput: ((Upstream.Output) -> Void)?
public var receiveCompletion:
((Subscribers.Completion<Upstream.Failure>) -> Void)?
public var receiveCancel: (() -> Void)?
public var receiveRequest: ((Subscribers.Demand) -> Void)?
private var events: Publishers.HandleEvents<Upstream>?
private let downstream: Downstream
init(_ events: Publishers.HandleEvents<Upstream>, downstream: Downstream) {
self.receiveSubscription = events.receiveSubscription
self.receiveOutput = events.receiveOutput
self.receiveCompletion = events.receiveCompletion
self.receiveCancel = events.receiveCancel
self.receiveRequest = events.receiveRequest
self.events = events
self.downstream = downstream
}
@@ -161,83 +125,61 @@ extension Publishers.HandleEvents {
}
func receive(subscription: Subscription) {
events?.receiveSubscription?(subscription)
lock.lock()
if let receiveSubscription = self.receiveSubscription {
lock.unlock()
receiveSubscription(subscription)
lock.lock()
}
guard case .awaitingSubscription = status else {
lock.unlock()
subscription.cancel()
return
}
status = .subscribed(subscription)
let pendingDemand = self.pendingDemand
self.pendingDemand = .none
lock.unlock()
downstream.receive(subscription: self)
if pendingDemand > 0 {
subscription.request(pendingDemand)
}
}
func receive(_ input: Input) -> Subscribers.Demand {
lock.lock()
if let receiveOutput = self.receiveOutput {
lock.unlock()
receiveOutput(input)
} else {
lock.unlock()
}
func receive(_ input: Upstream.Output) -> Subscribers.Demand {
events?.receiveOutput?(input)
let newDemand = downstream.receive(input)
if newDemand == .none {
return newDemand
}
lock.lock()
if let receiveRequest = self.receiveRequest {
lock.unlock()
receiveRequest(newDemand)
} else {
lock.unlock()
if newDemand > 0 {
events?.receiveRequest?(newDemand)
}
return newDemand
}
func receive(completion: Subscribers.Completion<Failure>) {
func receive(completion: Subscribers.Completion<Upstream.Failure>) {
events?.receiveCompletion?(completion)
lock.lock()
if let receiveCompletion = self.receiveCompletion {
lock.unlock()
receiveCompletion(completion)
lock.lock()
}
lockedTerminate()
events = nil
status = .terminal
lock.unlock()
downstream.receive(completion: completion)
}
func request(_ demand: Subscribers.Demand) {
events?.receiveRequest?(demand)
lock.lock()
if let receiveRequest = self.receiveRequest {
lock.unlock()
receiveRequest(demand)
lock.lock()
}
guard case let .subscribed(subscription) = status else {
if case let .subscribed(subscription) = status {
lock.unlock()
subscription.request(demand)
return
}
pendingDemand += demand
lock.unlock()
subscription.request(demand)
}
func cancel() {
events?.receiveCancel?()
lock.lock()
if let receiveCancel = self.receiveCancel {
lock.unlock()
receiveCancel()
lock.lock()
}
guard case let .subscribed(subscription) = status else {
lock.unlock()
return
}
lockedTerminate()
events = nil
status = .terminal
lock.unlock()
subscription.cancel()
}
@@ -247,14 +189,5 @@ extension Publishers.HandleEvents {
var customMirror: Mirror { return Mirror(self, children: EmptyCollection()) }
var playgroundDescription: Any { return description }
private func lockedTerminate() {
receiveSubscription = nil
receiveOutput = nil
receiveCompletion = nil
receiveCancel = nil
receiveRequest = nil
status = .terminal
}
}
}
@@ -6,33 +6,10 @@
extension Publisher {
/// Ingores all upstream elements, but passes along a completion state (finished or
/// failed).
///
/// Use the `ignoreOutput(`` operator to determine if a publisher is able to complete
/// successfully or would fail.
///
/// In the example below, the array publisher (`numbers`) delivers the first five of
/// its elements successfully, as indicated by the `ignoreOutput()` operator.
/// The operator consumes, but doesnt republish the elements downstream. However,
/// the sixth element, `0`, causes the error throwing closure to catch
/// a `NoZeroValuesAllowedError` that terminates the stream.
///
/// struct NoZeroValuesAllowedError: Error {}
/// let numbers = [1, 2, 3, 4, 5, 0, 6, 7, 8, 9]
/// cancellable = numbers.publisher
/// .tryFilter({ anInt in
/// guard anInt != 0 else { throw NoZeroValuesAllowedError() }
/// return anInt < 20
/// })
/// .ignoreOutput()
/// .sink(receiveCompletion: {print("completion: \($0)")},
/// receiveValue: {print("value \($0)")})
///
/// // Prints: "completion: failure(NoZeroValuesAllowedError())"
/// Ingores all upstream elements, but passes along a completion
/// state (finished or failed).
///
/// The output type of this publisher is `Never`.
///
/// - Returns: A publisher that ignores all upstream elements.
public func ignoreOutput() -> Publishers.IgnoreOutput<Self> {
return .init(upstream: self)
@@ -64,27 +41,44 @@ extension Publishers {
}
extension Publishers.IgnoreOutput {
private struct Inner<Downstream: Subscriber>
private final class Inner<Downstream: Subscriber>
: Subscriber,
Subscription,
CustomStringConvertible,
CustomReflectable,
CustomPlaygroundDisplayConvertible
where Downstream.Input == Never, Downstream.Failure == Upstream.Failure
{
// NOTE: This class has been audited for thread safety
typealias Input = Upstream.Output
typealias Failure = Upstream.Failure
private let downstream: Downstream
let combineIdentifier = CombineIdentifier()
private var status = SubscriptionStatus.awaitingSubscription
private let lock = UnfairLock.allocate()
fileprivate init(downstream: Downstream) {
self.downstream = downstream
}
deinit {
lock.deallocate()
}
func receive(subscription: Subscription) {
downstream.receive(subscription: subscription)
lock.lock()
guard case .awaitingSubscription = status else {
lock.unlock()
subscription.cancel()
return
}
status = .subscribed(subscription)
lock.unlock()
downstream.receive(subscription: self)
subscription.request(.unlimited)
}
@@ -93,13 +87,42 @@ extension Publishers.IgnoreOutput {
}
func receive(completion: Subscribers.Completion<Failure>) {
lock.lock()
guard case .subscribed = status else {
lock.unlock()
return
}
status = .terminal
lock.unlock()
downstream.receive(completion: completion)
}
func request(_ demand: Subscribers.Demand) {
// ignore and requests from downstream since we'll never send
// any values
}
func cancel() {
lock.lock()
guard case let .subscribed(subscription) = status else {
lock.unlock()
return
}
status = .terminal
lock.unlock()
subscription.cancel()
}
var description: String { return "IgnoreOutput" }
var customMirror: Mirror {
return Mirror(self, children: EmptyCollection())
lock.lock()
defer { lock.unlock() }
let children: [Mirror.Child] = [
("downstream", downstream),
("status", status)
]
return Mirror(self, children: children)
}
var playgroundDescription: Any { return description }
@@ -7,82 +7,33 @@
extension Publisher {
/// Publishes the last element of a stream, after the stream finishes.
///
/// Use `last()` when you need to emit only the last element from an upstream
/// publisher.
///
/// In the example below, the range publisher only emits the last element from
/// the sequence publisher, `10`, then finishes normally.
///
/// let numbers = (-10...10)
/// cancellable = numbers.publisher
/// .last()
/// .sink { print("\($0)") }
///
/// // Prints: "10"
///
/// Only publishes the last element of a stream, after the stream finishes.
/// - Returns: A publisher that only publishes the last element of a stream.
public func last() -> Publishers.Last<Self> {
return .init(upstream: self)
}
/// Publishes the last element of a stream that satisfies a predicate closure,
/// after upstream finishes.
///
/// Use `last(where:)` when you need to republish only the last element of a stream
/// that satisfies a closure you specify.
///
/// In the example below, a range publisher emits the last element that satisfies
/// the closures criteria, then finishes normally:
///
/// let numbers = (-10...10)
/// cancellable = numbers.publisher
/// .last { $0 < 6 }
/// .sink { print("\($0)") }
///
/// // Prints: "5"
/// Only publishes the last element of a stream that satisfies a predicate closure,
/// after the stream finishes.
///
/// - Parameter predicate: A closure that takes an element as its parameter and
/// returns a Boolean value that indicates whether to publish the element.
/// - Returns: A publisher that only publishes the last element satisfying the given
/// predicate.
/// returns a Boolean value indicating whether to publish the element.
/// - Returns: A publisher that only publishes the last element satisfying
/// the given predicate.
public func last(
where predicate: @escaping (Output) -> Bool
) -> Publishers.LastWhere<Self> {
return .init(upstream: self, predicate: predicate)
}
/// Publishes the last element of a stream that satisfies an error-throwing predicate
/// closure, after the stream finishes.
///
/// Use `tryLast(where:)` when you need to republish the last element that satisfies
/// an error-throwing closure you specify. If the predicate closure throws an error,
/// the publisher fails.
///
/// In the example below, a publisher emits the last element that satisfies
/// the error-throwing closure, then finishes normally:
///
/// struct RangeError: Error {}
///
/// let numbers = [-62, 1, 6, 10, 9, 22, 41, -1, 5]
/// cancellable = numbers.publisher
/// .tryLast {
/// guard 0 != 0 else {throw RangeError()}
/// return true
/// }
/// .sink(
/// receiveCompletion: { print ("completion: \($0)", terminator: " ") },
/// receiveValue: { print ("\($0)", terminator: " ") }
/// )
/// // Prints: "5 completion: finished"
/// // If instead the numbers array had contained a `0`, the `tryLast` operator
/// // would terminate publishing with a RangeError."
/// Only publishes the last element of a stream that satisfies an error-throwing
/// predicate closure, after the stream finishes.
///
/// If the predicate closure throws, the publisher fails with the thrown error.
/// - Parameter predicate: A closure that takes an element as its parameter and
/// returns a Boolean value that indicates whether to publish the element.
/// - Returns: A publisher that only publishes the last element satisfying the given
/// predicate.
/// returns a Boolean value indicating whether to publish the element.
/// - Returns: A publisher that only publishes the last element satisfying
/// the given predicate.
public func tryLast(
where predicate: @escaping (Output) throws -> Bool
) -> Publishers.TryLastWhere<Self> {
@@ -9,34 +9,6 @@ extension Publisher where Failure == Never {
/// Creates a connectable wrapper around the publisher.
///
/// In the following example, `makeConnectable()` wraps its upstream publisher
/// (an instance of `Publishers.Share`) with a `ConnectablePublisher`. Without this,
/// the first sink subscriber would receive all the elements from the sequence
/// publisher and cause it to complete before the second subscriber attaches.
/// By making the publisher connectable, the publisher doesnt produce any elements
/// until after the `connect()` call.
///
/// let subject = Just<String>("Sent")
/// let pub = subject
/// .share()
/// .makeConnectable()
/// cancellable1 = pub.sink { print ("Stream 1 received: \($0)") }
///
/// // For example purposes, use DispatchQueue to add a second subscriber
/// // a second later, and then connect to the publisher a second after that.
/// DispatchQueue.main.asyncAfter(deadline: .now() + 1) {
/// self.cancellable2 = pub.sink { print ("Stream 2 received: \($0)") }
/// }
/// DispatchQueue.main.asyncAfter(deadline: .now() + 2) {
/// self.connectable = pub.connect()
/// }
/// // Prints:
/// // Stream 2 received: Sent
/// // Stream 1 received: Sent
///
/// > Note: The `connect()` operator returns a `Cancellable` instance that you must
/// retain. You can also use this instance to cancel publishing.
///
/// - Returns: A `ConnectablePublisher` wrapping this publisher.
public func makeConnectable() -> Publishers.MakeConnectable<Self> {
return .init(upstream: self)
@@ -45,15 +17,6 @@ extension Publisher where Failure == Never {
extension Publishers {
/// A publisher that provides explicit connectability to another publisher.
///
/// `Publishers.MakeConnectable` is a `ConnectablePublisher`, which allows you to
/// perform configuration before publishing any elements. Call `connect()` on this
/// publisher when you want to attach to its upstream publisher and start producing
/// elements.
///
/// Use the `makeConnectable()` operator to wrap an upstream publisher with
/// an instance of this publisher.
public struct MakeConnectable<Upstream: Publisher>: ConnectablePublisher {
public typealias Output = Upstream.Output
@@ -62,9 +25,6 @@ extension Publishers {
private let inner: Multicast<Upstream, PassthroughSubject<Output, Failure>>
/// Creates a connectable publisher, attached to the provide upstream publisher.
///
/// - Parameter upstream: The publisher from which to receive elements.
public init(upstream: Upstream) {
inner = upstream.multicast(subject: .init())
}
@@ -9,30 +9,6 @@ extension Publisher {
/// Transforms all elements from the upstream publisher with a provided closure.
///
/// OpenCombines `map(_:)` operator performs a function similar to that of `map(_:)`
/// in the Swift standard library: it uses a closure to transform each element it
/// receives from the upstream publisher. You use `map(_:)` to transform from one kind
/// of element to another.
///
/// The following example uses an array of numbers as the source for a collection
/// based publisher. A `map(_:)` operator consumes each integer from the publisher and
/// uses a dictionary to transform it from its Arabic numeral to a Roman equivalent,
/// as a `String`.
/// If the `map(_:)`s closure fails to look up a Roman numeral, it returns the string
/// `(unknown)`.
///
/// let numbers = [5, 4, 3, 2, 1, 0]
/// let romanNumeralDict: [Int : String] =
/// [1:"I", 2:"II", 3:"III", 4:"IV", 5:"V"]
/// cancellable = numbers.publisher
/// .map { romanNumeralDict[$0] ?? "(unknown)" }
/// .sink { print("\($0)", terminator: " ") }
///
/// // Prints: "V IV III II I (unknown)"
///
/// If your closure can throw an error, use OpenCombines `tryMap(_:)` operator
/// instead.
///
/// - Parameter transform: A closure that takes one element as its parameter and
/// returns a new element.
/// - Returns: A publisher that uses the provided closure to map elements from
@@ -43,47 +19,14 @@ extension Publisher {
return Publishers.Map(upstream: self, transform: transform)
}
/// Transforms all elements from the upstream publisher with a provided error-throwing
/// closure.
/// Transforms all elements from the upstream publisher with a provided
/// error-throwing closure.
///
/// OpenCombines `tryMap(_:)` operator performs a function similar to that of
/// `map(_:)` in the Swift standard library: it uses a closure to transform each
/// element it receives from the upstream publisher. You use `tryMap(_:)` to transform
/// from one kind of element to another, and to terminate publishing when the maps
/// closure throws an error.
///
/// The following example uses an array of numbers as the source for a collection
/// based publisher. A `tryMap(_:)` operator consumes each integer from the publisher
/// and uses a dictionary to transform it from its Arabic numeral to a Roman
/// equivalent, as a `String`.
/// If the `tryMap(_:)`s closure fails to look up a Roman numeral, it throws
/// an error. The `tryMap(_:)` operator catches this error and terminates publishing,
/// sending a `Subscribers.Completion.failure(_:)` that wraps the error.
///
/// struct ParseError: Error {}
/// func romanNumeral(from:Int) throws -> String {
/// let romanNumeralDict: [Int : String] =
/// [1:"I", 2:"II", 3:"III", 4:"IV", 5:"V"]
/// guard let numeral = romanNumeralDict[from] else {
/// throw ParseError()
/// }
/// return numeral
/// }
/// let numbers = [5, 4, 3, 2, 1, 0]
/// cancellable = numbers.publisher
/// .tryMap { try romanNumeral(from: $0) }
/// .sink(
/// receiveCompletion: { print ("completion: \($0)") },
/// receiveValue: { print ("\($0)", terminator: " ") }
/// )
///
/// // Prints: "V IV III II I completion: failure(ParseError())"
///
/// If your closure doesnt throw, use `map(_:)` instead.
/// If the `transform` closure throws an error, the publisher fails with the thrown
/// error.
///
/// - Parameter transform: A closure that takes one element as its parameter and
/// returns a new element. If the closure throws an error, the publisher fails with
/// the thrown error.
/// returns a new element.
/// - Returns: A publisher that uses the provided closure to map elements from
/// the upstream publisher to new elements that it then publishes.
public func tryMap<Result>(
@@ -91,30 +34,6 @@ extension Publisher {
) -> Publishers.TryMap<Self, Result> {
return Publishers.TryMap(upstream: self, transform: transform)
}
/// Replaces `nil` elements in the stream with the provided element.
///
/// The `replaceNil(with:)` operator enables replacement of `nil` values in a stream
/// with a substitute value. In the example below, a collection publisher contains
/// a `nil` value. The `replaceNil(with:)` operator replaces this with `0.0`.
///
/// let numbers: [Double?] = [1.0, 2.0, nil, 3.0]
/// numbers.publisher
/// .replaceNil(with: 0.0)
/// .sink { print("\($0)", terminator: " ") }
///
/// // Prints: "Optional(1.0) Optional(2.0) Optional(0.0) Optional(3.0)"
///
/// - Parameter output: The element to use when replacing `nil`.
/// - Returns: A publisher that replaces `nil` elements from the upstream publisher
/// with the provided element.
public func replaceNil<ElementOfResult>(
with output: ElementOfResult
) -> Publishers.Map<Self, ElementOfResult>
where Output == ElementOfResult?
{
return Publishers.Map(upstream: self) { $0 ?? output }
}
}
extension Publishers {
@@ -299,7 +218,13 @@ extension Publishers.TryMap {
return try downstream.receive(map(input))
} catch {
lock.lock()
let subscription = status.subscription
let subscription: Subscription?
switch status {
case let .subscribed(upstreamSubscription):
subscription = upstreamSubscription
case .awaitingSubscription, .terminal:
subscription = nil
}
status = .terminal
lock.unlock()
subscription?.cancel()
@@ -45,44 +45,13 @@ extension Publisher {
/// Converts any failure from the upstream publisher into a new error.
///
/// Use the `mapError(_:)` operator when you need to replace one error type with
/// another, or where a downstream operator needs the error types of its inputs to
/// match.
/// Until the upstream publisher finishes normally or fails with an error,
/// the returned publisher republishes all the elements it receives.
///
/// The following example uses a `tryMap(_:)` operator to divide `1` by each element
/// produced by a sequence publisher. When the publisher produces a `0`,
/// the `tryMap(_:)` fails with a `DivisionByZeroError`. The `mapError(_:)` operator
/// converts this into a `MyGenericError`.
///
/// struct DivisionByZeroError: Error {}
/// struct MyGenericError: Error { var wrappedError: Error }
///
/// func myDivide(_ dividend: Double, _ divisor: Double) throws -> Double {
/// guard divisor != 0 else { throw DivisionByZeroError() }
/// return dividend / divisor
/// }
///
/// let divisors: [Double] = [5, 4, 3, 2, 1, 0]
/// divisors.publisher
/// .tryMap { try myDivide(1, $0) }
/// .mapError { MyGenericError(wrappedError: $0) }
/// .sink(
/// receiveCompletion: { print ("completion: \($0)") ,
/// receiveValue: { print ("value: \($0)") }
/// )
///
/// // Prints:
/// // value: 0.2
/// // value: 0.25
/// // value: 0.3333333333333333
/// // value: 0.5
/// // value: 1.0
/// // completion: failure(MyGenericError(wrappedError: DivisionByZeroError()))"
///
/// - Parameter transform: A closure that takes the upstream failure as a parameter
/// and returns a new error for the publisher to terminate with.
/// - Returns: A publisher that replaces any upstream failure with a new error
/// produced by the `transform` closure.
/// - Parameter transform: A closure that takes the upstream failure as a
/// parameter and returns a new error for the publisher to terminate with.
/// - Returns: A publisher that replaces any upstream failure with a
/// new error produced by the `transform` closure.
public func mapError<NewFailure: Error>(
_ transform: @escaping (Failure) -> NewFailure
) -> Publishers.MapError<Self, NewFailure>
@@ -12,10 +12,6 @@ from gyb_opencombine_support import (
list_with_suffix_variadic
)
import random
RNG = random.Random(0)
instantiations = [(1, '', ''),
(2, 'two', 'second '),
(3, 'three', 'third ')]
@@ -45,66 +41,18 @@ extension Publisher {
%
% publisher_name = make_publisher_name(arity)
%
% doc_cardinal = 'a key path' if arity == 1 else cardinal + ' key paths'
%
% doc_comment_suffix = 'value of the key path' \
% if arity == 1 else 'values of {} key paths as a tuple'.format(cardinal)
%
% doc_output_values = 'the value of this `Int`' \
% if arity == 1 else 'these {} values (as an `({})` tuple)' \
% .format(cardinal, ', '.join(['Int'] * arity))
%
% example_dice_roll_properties = ['die'] \
% if arity == 1 else ['die{}'.format(i + 1) for i in range(arity)]
% enumerated_example_dice_roll_properties = '`die` member' \
% if arity == 1 else ('`die1` and `die2`' if arity == 2 else \
% ''.join(['`{}`, '.format(s) for s in example_dice_roll_properties[:-1]]) + \
% 'and `{}`'.format(example_dice_roll_properties[-1])) + ' members'
%
% dice_roll_init = ',\n /// ' \
% .join([s + ': Int.random(in: 1...6)' for s in example_dice_roll_properties])
/// Publishes the ${doc_comment_suffix}.
///
/// In the following example, the `map(${'_:' * arity})` operator uses the Swift
/// key path syntax to access the ${enumerated_example_dice_roll_properties}
/// of the `DiceRoll` structure published by the `Just` publisher.
///
/// The downstream sink subscriber receives only
/// ${doc_output_values},
/// not the entire `DiceRoll`.
///
/// struct DiceRoll {
% for prop in example_dice_roll_properties:
/// let ${prop}: Int
% end
/// }
///
/// cancellable = Just(DiceRoll(${dice_roll_init}))
/// .map(${', '.join(['\.' + s for s in example_dice_roll_properties])})
% if arity == 1:
/// .sink {
/// print ("Rolled: \($0)")
/// }
% else:
% closure_args = ['values.{}'.format(i) for i in range(arity)]
/// .sink { values in
/// print("""
/// Rolled: ${', '.join(['\\({})'.format(s) for s in closure_args])} \
/// (total \(${' + '.join(closure_args)}))
/// """)
/// }
% end
% random_numbers = [RNG.randint(1, 6) for _ in range(arity)]
% random_numbers_printed = ', '.join([str(i) for i in random_numbers]) + \
% (' (or some other random value)' if arity == 1 \
% else ' (total: {})" (or other random values)'.format(sum(random_numbers)))
/// // Prints "Rolled: ${random_numbers_printed}.
% doc_cardinal = 'a keyt path' if arity == 1 else cardinal + ' key paths'
/// Returns a publisher that publishes the values of ${doc_cardinal} as a tuple.
///
/// - Parameters:
% for i in range(arity):
% ordinal = 'another ' if i == 1 and arity < 3 else 'a ' + instantiations[i][2]
/// - ${key_path_var(i, arity)}: The key path of ${ordinal}property on `Output`.
% ordinal = 'another ' if i == 1 else 'a ' + instantiations[i][2]
/// - ${key_path_var(i, arity)}: The key path of ${ordinal}property on `Output`
% end
%
% doc_comment_suffix = 'value of the key path' \
% if arity == 1 else 'values of {} key paths as a tuple'.format(cardinal)
/// - Returns: A publisher that publishes the ${doc_comment_suffix}.
public func map<${cs_result_types}>(
${method_args_joined}
@@ -10,30 +10,11 @@ extension Publisher {
/// Measures and emits the time interval between events received from an upstream
/// publisher.
///
/// Use `measureInterval(using:options:)` to measure the time between events delivered
/// from an upstream publisher.
///
/// In the example below, a 1-second `Timer` is used as the data source for an event
/// publisher; the `measureInterval(using:options:)` operator reports the elapsed time
/// between the reception of events on the main run loop:
///
/// cancellable = Timer.publish(every: 1, on: .main, in: .default)
/// .autoconnect()
/// .measureInterval(using: RunLoop.main)
/// .sink { print("\($0)", terminator: "\n") }
///
/// // Prints:
/// // Stride(magnitude: 1.0013610124588013)
/// // Stride(magnitude: 0.9992760419845581)
///
/// The output type of the returned publisher is the time interval of the provided
/// The output type of the returned scheduler is the time interval of the provided
/// scheduler.
///
/// This operator uses the provided schedulers `now` property to measure intervals
/// between events.
///
/// - Parameters:
/// - scheduler: A scheduler to use for tracking the timing of events.
/// - scheduler: The scheduler on which to deliver elements.
/// - options: Options that customize the delivery of elements.
/// - Returns: A publisher that emits elements representing the time interval between
/// the elements it receives.
@@ -58,15 +39,9 @@ extension Publishers {
/// The publisher from which this publisher receives elements.
public let upstream: Upstream
/// The scheduler used for tracking the timing of events.
/// The scheduler on which to deliver elements.
public let scheduler: Context
/// Creates a publisher that measures and emits the time interval between events
/// received from an upstream publisher.
///
/// - Parameters:
/// - upstream: The publisher from which this publisher receives elements.
/// - scheduler: A scheduler to use for tracking the timing of events.
public init(upstream: Upstream, scheduler: Context) {
self.upstream = upstream
self.scheduler = scheduler
@@ -76,7 +51,7 @@ extension Publishers {
where Upstream.Failure == Downstream.Failure,
Downstream.Input == Context.SchedulerTimeType.Stride
{
upstream.subscribe(Inner(scheduler: scheduler, downstream: subscriber))
upstream.subscribe(Inner(self, downstream: subscriber))
}
}
}
@@ -91,22 +66,27 @@ extension Publishers.MeasureInterval {
where Downstream.Input == Context.SchedulerTimeType.Stride,
Downstream.Failure == Upstream.Failure
{
// NOTE: This class has been audited for thread safety
typealias Input = Upstream.Output
typealias Failure = Upstream.Failure
typealias MeasureInterval = Publishers.MeasureInterval<Upstream, Context>
private enum State {
case ready(MeasureInterval, Downstream)
case subscribed(MeasureInterval, Downstream, Subscription)
case terminal
}
private let lock = UnfairLock.allocate()
private let downstream: Downstream
private let scheduler: Context
private var state = SubscriptionStatus.awaitingSubscription
private var state: State
private var last: Context.SchedulerTimeType?
init(scheduler: Context, downstream: Downstream) {
self.downstream = downstream
self.scheduler = scheduler
init(_ measureInterval: MeasureInterval, downstream: Downstream) {
state = .ready(measureInterval, downstream)
}
deinit {
@@ -115,26 +95,25 @@ extension Publishers.MeasureInterval {
func receive(subscription: Subscription) {
lock.lock()
guard case .awaitingSubscription = state else {
guard case let .ready(measureInterval, downstream) = state else {
lock.unlock()
subscription.cancel()
return
}
state = .subscribed(subscription)
last = scheduler.now
state = .subscribed(measureInterval, downstream, subscription)
last = measureInterval.scheduler.now
lock.unlock()
downstream.receive(subscription: self)
}
func receive(_: Input) -> Subscribers.Demand {
lock.lock()
guard case let .subscribed(subscription) = state,
let previousTime = last else
{
guard case let .subscribed(measureInterval, downstream, subscription) = state,
let previousTime = last else {
lock.unlock()
return .none
}
let now = scheduler.now
let now = measureInterval.scheduler.now
last = now
lock.unlock()
let newDemand = downstream.receive(previousTime.distance(to: now))
@@ -146,7 +125,7 @@ extension Publishers.MeasureInterval {
func receive(completion: Subscribers.Completion<Failure>) {
lock.lock()
guard case .subscribed = state else {
guard case let .subscribed(_, downstream, _) = state else {
lock.unlock()
return
}
@@ -158,7 +137,7 @@ extension Publishers.MeasureInterval {
func request(_ demand: Subscribers.Demand) {
lock.lock()
guard case let .subscribed(subscription) = state else {
guard case let .subscribed(_, _, subscription) = state else {
lock.unlock()
return
}
@@ -168,7 +147,7 @@ extension Publishers.MeasureInterval {
func cancel() {
lock.lock()
guard case let .subscribed(subscription) = state else {
guard case let .subscribed(_, _, subscription) = state else {
lock.unlock()
return
}
@@ -0,0 +1,285 @@
${template_header}
//
// Publishers.Merge.swift.gyb
//
//
// Created by Sergej Jaskiewicz on 04/10/2019.
//
%{
from gyb_opencombine_support import (
suffix_variadic,
list_with_suffix_variadic,
indent
)
import string
instantiations = [(2, 'two', 'A second'),
(3, 'three', 'A third'),
(4, 'four', 'A fourth'),
(5, 'five', 'A fifth'),
(6, 'six', 'A sixth'),
(7, 'seven', 'A seventh'),
(8, 'eight', 'An eighth')]
def make_publisher_name(arity):
return suffix_variadic('Merge', arity, arity - 1)
def make_upstream_types(arity, start=0):
return [str(c) for c in string.ascii_uppercase[start:arity]]
def make_upstream_types_reversed(arity):
return [str(c) for c in reversed(string.ascii_uppercase)][:arity]
def make_upstream_generic_constraints(upstream_types, first_is_self=False):
format_string = '{0}Failure == {1}.Failure, {0}Output == {1}.Output'
def format(i):
return format_string.format(upstream_types[i] + '.',
upstream_types[i + 1])
result = [format(i) for i in range(len(upstream_types) - 1)]
if first_is_self:
result.insert(0, format_string.format('', upstream_types[0]))
return result
def declare_merge_method(arg_count, arity, indent_spaces_count):
assert(arg_count <= arity - 1)
is_specialization = arg_count < arity - 1
declaration_format = """\
public func merge<
{}
>(with {}) -> Publishers.{}<{}>\
"""
where_clause_format = '\n where {}'
if arg_count == 1:
upstream_types = ['P']
elif is_specialization:
upstream_types = make_upstream_types_reversed(arg_count)
else:
upstream_types = make_upstream_types(arg_count + 1, 1)
method_generic_params = \
[upstream_type + ': Publisher' for upstream_type in upstream_types]
cs_method_generic_params = \
(',\n ').join(method_generic_params)
method_args = ['other: P'] \
if arg_count == 1 else ['{}: {}'.format(upstream_type.lower(), upstream_type) \
for upstream_type in upstream_types]
cs_method_args = ',\n _ '.join(method_args)
publisher_name = make_publisher_name(arity)
self_generic_params = make_upstream_types(arity - arg_count) \
if is_specialization else ['Self']
publisher_generic_params = self_generic_params + upstream_types
cs_publisher_generic_params = ', '.join(publisher_generic_params)
generic_constraints = make_upstream_generic_constraints(upstream_types, True)
cs_generic_constraints = \
',\n '.join(generic_constraints)
declaration = declaration_format.format(cs_method_generic_params,
cs_method_args,
publisher_name,
cs_publisher_generic_params)
if not is_specialization:
declaration += where_clause_format.format(cs_generic_constraints)
return indent(declaration, indent_spaces_count)
}%
// swiftlint:disable generic_type_name
// swiftlint:disable vertical_parameter_alignment
// MARK: - Merge methods on Publisher
extension Publisher {
% for arity, _, _ in instantiations:
%
% doc_cardinal = 'another publisher' \
% if arity == 2 else (instantiations[arity - 2][1] + ' other publishers')
% argument_names = ['other'] \
% if arity == 2 else [upstream_type.lower() \
% for upstream_type in make_upstream_types(arity, 1)]
/// Combines elements from this publisher with those from ${doc_cardinal},
/// delivering an interleaved sequence of elements.
///
/// The merged publisher continues to emit elements until all upstream publishers
/// finish. If an upstream publisher produces an error, the merged publisher fails
/// with that error.
///
/// - Parameters:
% for i in range(arity - 1):
% param_doc = 'Another' if arity == 2 else instantiations[i][2]
/// - ${argument_names[i]}: ${param_doc} publisher.
% end
/// - Returns: A publisher that emits an event when any upstream publisher emits
/// an event.
${declare_merge_method(arity - 1, arity, 4)}
{
return .init(self, ${', '.join(argument_names)})
}
% end
}
extension Publisher {
/// Combines elements from this publisher with those from another publisher of
/// the same type, delivering an interleaved sequence of elements.
///
/// - Parameter other: Another publisher of this publisher's type.
/// - Returns: A publisher that emits an event when either upstream publisher emits
/// an event.
public func merge(with other: Self) -> Publishers.MergeMany<Self> {
return .init([self, other])
}
}
// MARK: - Merge publishers
extension Publishers {
% for arity, cardinal, _ in instantiations:
%
% publisher_name = make_publisher_name(arity)
%
% upstream_types = make_upstream_types(arity)
%
% upstream_generic_params = \
% [upstream_type + ': Publisher' for upstream_type in upstream_types]
%
% cs_upstream_generic_params = \
% (',\n' + (19 + len(publisher_name)) * ' ').join(upstream_generic_params)
%
% upstream_generic_constraints = \
% make_upstream_generic_constraints(upstream_types)
%
% cs_upstream_generic_constraints = \
% ',\n '.join(upstream_generic_constraints)
%
% init_args = ['_ {}: {}'.format(upstream_type.lower(), upstream_type) \
% for upstream_type in upstream_types]
% cs_init_args = ',\n '.join(init_args)
%
% self_fields = [upstream_type.lower() for upstream_type in upstream_types]
/// A publisher created by applying the merge function to ${cardinal} upstream
/// publishers.
public struct ${publisher_name}<${cs_upstream_generic_params}>: Publisher
where ${cs_upstream_generic_constraints}
{
public typealias Output = ${upstream_types[0]}.Output
public typealias Failure = ${upstream_types[0]}.Failure
% for upstream_type in upstream_types:
public let ${upstream_type.lower()}: ${upstream_type}
% end
public init(
${cs_init_args}
) {
% for self_field in self_fields:
self.${self_field} = ${self_field}
% end
}
public func receive<Downstream: Subscriber>(subscriber: Downstream)
where ${upstream_types[0]}.Failure == Downstream.Failure,
${upstream_types[0]}.Output == Downstream.Input
{
typealias Merged = _Merged<Output, Failure, Downstream>
let merged = Merged(downstream: subscriber, count: ${arity})
% for i in range(len(self_fields)):
${self_fields[i]}.subscribe(Merged.Side(index: ${i}, merger: merged))
% end
subscriber.receive(subscription: merged)
}
% for i in range(len(instantiations) + 1 - arity):
% argument_names = ['other'] \
% if i == 0 else [upstream_type.lower() \
% for upstream_type in make_upstream_types_reversed(i + 1)]
%
${declare_merge_method(i + 1, arity + i + 1, 8)}
{
return .init(${', '.join(self_fields + argument_names)})
}
% end
}
% end
}
extension Publishers {
public struct MergeMany<Upstream: Publisher>: Publisher {
public typealias Output = Upstream.Output
public typealias Failure = Upstream.Failure
public let publishers: [Upstream]
public init(_ upstream: Upstream...) {
self.publishers = upstream
}
public init<UpstreamPublishers: Swift.Sequence>(_ upstream: UpstreamPublishers)
where Upstream == UpstreamPublishers.Element
{
publishers = Array(upstream)
}
public func receive<Downstream: Subscriber>(subscriber: Downstream)
where Upstream.Failure == Downstream.Failure,
Upstream.Output == Downstream.Input
{
typealias Merged = _Merged<Output, Failure, Downstream>
let merged = Merged(downstream: subscriber, count: publishers.count)
for (i, upstream) in publishers.enumerated() {
upstream.subscribe(Merged.Side(index: i, merger: merged))
}
subscriber.receive(subscription: merged)
}
public func merge(with other: Upstream) -> Publishers.MergeMany<Upstream> {
var newPublishers = publishers
newPublishers.append(other)
return .init(newPublishers)
}
}
}
// MARK: - Equatable conformances
% for arity, cardinal, _ in instantiations:
%
% publisher_name = make_publisher_name(arity)
%
% upstream_types = make_upstream_types(arity)
%
% constraints = [upstream_type + ': Equatable' for upstream_type in upstream_types]
% cs_constraints = ',\n'.join(constraints)
% cs_constraints = indent(cs_constraints, 8)
%
extension Publishers.${publisher_name}: Equatable
where
${cs_constraints} {}
% end
extension Publishers.MergeMany: Equatable
where
Upstream: Equatable {}
@@ -11,45 +11,10 @@ extension Publisher {
///
/// Use a multicast publisher when you have multiple downstream subscribers, but you
/// want upstream publishers to only process one `receive(_:)` call per event.
/// This is useful when upstream publishers are doing expensive work you dont want
/// to duplicate, like performing network requests.
///
/// In contrast with `multicast(subject:)`, this method produces a publisher that
/// creates a separate `Subject` for each subscriber.
/// creates a separate Subject for each subscriber.
///
/// The following example uses a sequence publisher as a counter to publish three
/// random numbers, generated by a `map(_:)` operator.
/// It uses a `multicast(_:)` operator whose closure creates a `PassthroughSubject`
/// to share the same random number to each of two subscribers. Because the multicast
/// publisher is a `ConnectablePublisher`, publishing only begins after a call to
/// `connect()`.
///
/// let pub = ["First", "Second", "Third"].publisher
/// .map( { return ($0, Int.random(in: 0...100)) } )
/// .print("Random")
/// .multicast { PassthroughSubject<(String, Int), Never>() }
///
/// cancellable1 = pub
/// .sink { print ("Stream 1 received: \($0)")}
/// cancellable2 = pub
/// .sink { print ("Stream 2 received: \($0)")}
/// pub.connect()
///
/// // Prints:
/// // Random: receive value: (("First", 9))
/// // Stream 2 received: ("First", 9)
/// // Stream 1 received: ("First", 9)
/// // Random: receive value: (("Second", 46))
/// // Stream 2 received: ("Second", 46)
/// // Stream 1 received: ("Second", 46)
/// // Random: receive value: (("Third", 26))
/// // Stream 2 received: ("Third", 26)
/// // Stream 1 received: ("Third", 26)
///
/// In this example, the output shows that the `print(_:to:)` operator receives each
/// random value only one time, and then sends the value to both subscribers.
///
/// - Parameter createSubject: A closure to create a new `Subject` each time
/// - Parameter createSubject: A closure to create a new Subject each time
/// a subscriber attaches to the multicast publisher.
public func multicast<SubjectType: Subject>(
_ createSubject: @escaping () -> SubjectType
@@ -63,42 +28,8 @@ extension Publisher {
///
/// Use a multicast publisher when you have multiple downstream subscribers, but you
/// want upstream publishers to only process one `receive(_:)` call per event.
/// This is useful when upstream publishers are doing expensive work you dont want
/// to duplicate, like performing network requests.
///
/// In contrast with `multicast(_:)`, this method produces a publisher that shares
/// the provided `Subject` among all the downstream subscribers.
///
/// The following example uses a sequence publisher as a counter to publish three
/// random numbers, generated by a `map(_:)` operator.
/// It uses a `multicast(subject:)` operator with a `PassthroughSubject` to share
/// the same random number to each of two subscribers. Because the multicast publisher
/// is a `ConnectablePublisher`, publishing only begins after a call to `connect()`.
///
/// let pub = ["First", "Second", "Third"].publisher
/// .map( { return ($0, Int.random(in: 0...100)) } )
/// .print("Random")
/// .multicast(subject: PassthroughSubject<(String, Int), Never>())
///
/// cancellable1 = pub
/// .sink { print ("Stream 1 received: \($0)")}
/// cancellable2 = pub
/// .sink { print ("Stream 2 received: \($0)")}
/// pub.connect()
///
/// // Prints:
/// // Random: receive value: (("First", 78))
/// // Stream 2 received: ("First", 78)
/// // Stream 1 received: ("First", 78)
/// // Random: receive value: (("Second", 98))
/// // Stream 2 received: ("Second", 98)
/// // Stream 1 received: ("Second", 98)
/// // Random: receive value: (("Third", 61))
/// // Stream 2 received: ("Third", 61)
/// // Stream 1 received: ("Third", 61)
///
/// In this example, the output shows that the `print(_:to:)` operator receives each
/// random value only one time, and then sends the value to both subscribers.
/// In contrast with `multicast(_:)`, this method produces a publisher shares
/// the provided Subject among all the downstream subscribers.
///
/// - Parameter subject: A subject to deliver elements to downstream subscribers.
public func multicast<SubjectType: Subject>(
@@ -113,19 +44,18 @@ extension Publisher {
extension Publishers {
/// A publisher that uses a subject to deliver elements to multiple subscribers.
///
/// Use a multicast publisher when you have multiple downstream subscribers, but you
/// want upstream publishers to only process one `receive(_:)` call per event.
public final class Multicast<Upstream: Publisher, SubjectType: Subject>
: ConnectablePublisher
where Upstream.Failure == SubjectType.Failure,
Upstream.Output == SubjectType.Output
{
// NOTE: This class has been audited for thread safety
public typealias Output = Upstream.Output
public typealias Failure = Upstream.Failure
/// The publisher that this publisher receives elements from.
/// The publisher from which this publisher receives elements.
public let upstream: Upstream
/// A closure to create a new Subject each time a subscriber attaches
@@ -149,10 +79,12 @@ extension Publishers {
return subject
}
/// Creates a multicast publisher that applies a closure to create a subject that
/// delivers elements to subscribers.
/// Creates a multicast publisher that applies a closure to create a subject
/// that delivers elements to subscribers.
///
/// - Parameter createSubject: A closure that returns a `Subject` each time
/// - Parameter upstream: The publisher from which this publisher receives
/// elements.
/// - Parameter createSubject: A closure to create a new Subject each time
/// a subscriber attaches to the multicast publisher.
public init(upstream: Upstream, createSubject: @escaping () -> SubjectType) {
self.upstream = upstream
@@ -9,19 +9,6 @@ extension Publisher {
/// Republishes elements up to the specified maximum count.
///
/// Use `prefix(_:)` to limit the number of elements republished to the downstream
/// subscriber.
///
/// In the example below, the `prefix(_:)` operator limits its output to the first
/// two elements before finishing normally:
///
/// let numbers = (0...10)
/// cancellable = numbers.publisher
/// .prefix(2)
/// .sink { print("\($0)", terminator: " ") }
///
/// // Prints: "0 1"
///
/// - Parameter maxLength: The maximum number of elements to republish.
/// - Returns: A publisher that publishes up to the specified number of elements
/// before completing.
@@ -35,20 +22,8 @@ extension Publisher {
/// Publishes a specific element, indicated by its index in the sequence of published
/// elements.
///
/// Use `output(at:)` when you need to republish a specific element specified by
/// its position in the stream. If the publisher completes normally or with an error
/// before publishing the specified element, then the publisher doesnt produce any
/// elements.
///
/// In the example below, the array publisher emits the fifth element in the sequence
/// of published elements:
///
/// let numbers = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
/// numbers.publisher
/// .output(at: 5)
/// .sink { print("\($0)") }
///
/// // Prints: "6"
/// If the publisher completes normally or with an error before publishing
/// the specified element, then the publisher doesnt produce any elements.
///
/// - Parameter index: The index that indicates the element to publish.
/// - Returns: A publisher that publishes a specific indexed element.
@@ -58,21 +33,10 @@ extension Publisher {
/// Publishes elements specified by their range in the sequence of published elements.
///
/// Use `output(in:)` to republish a range indices you specify in the published
/// stream. After publishing all elements, the publisher finishes normally.
/// After all elements are published, the publisher finishes normally.
/// If the publisher completes normally or with an error before producing all
/// the elements in the range, it doesnt publish the remaining elements.
///
/// In the example below, an array publisher emits the subset of elements at
/// the indices in the specified range:
///
/// let numbers = [1, 1, 2, 2, 2, 3, 4, 5, 6]
/// numbers.publisher
/// .output(in: (3...5))
/// .sink { print("\($0)", terminator: " ") }
///
/// // Prints: "2 2 3"
///
/// - Parameter range: A range that indicates which elements to publish.
/// - Returns: A publisher that publishes elements specified by a range.
public func output<Range: RangeExpression>(in range: Range) -> Publishers.Output<Self>

Some files were not shown because too many files have changed in this diff Show More