Repository files navigation

CXShim is a virtual Combine interface that allows you to switch berween system Combine and open source Combine.

With CXShim, you shoudn't write different code for different Combine. If you find you are in need of it, please file an issue.

Add the following line to the dependencies in yourPackage.swift file:

.package(url:"https://github.com/cx-org/CXShim",.upToNextMinor(from:"0.4.0"),

• Swift 5.0+

Because Combine has system limitation, and open source Combine doesn't compatible with SwiftUI. With CXShim, You can easily write one package that compatible with SwiftUI, support Linux, and can backward deploy to iOS 9.0.

No, CXShim introduce no extra dependency, no runtime cost, no binary size incrementation. It's not infectious. Migrating from Combine to CXShim is a non-breaking change.

If your package use Combine, just replace everyimport Combine withimport CXShim, everything will still works fine. And witha little adjustment, your package can support Linux and lower system as well.

Because system Combine is used by default on Apple platforms. Don't worry, you can choose open source Combine manually and get rid of system requirement.

You can choose Combine implementation by setting environment variableCX_COMBINE_IMPLEMENTATION.

$export CX_COMBINE_IMPLEMENTATION=CombineX# for CLI tools, execute with env variable$ swift build ...$ xcodebuild ...# for Xcode GUI, reopen Xcode with env variable$ killall Xcode$ open Package.swift

CXShim conditionally re-export appropriate Combine implementation. It also fill the gap between different Combine. For example, you would have needed to write different code forCombine andCombineX:

#if BACKWARD_DEPLOYMENT // we are target on lower system and use CombineX// This method is under cx namespace because `URLSession.dataTaskPublisher` // can't be overloaded and always use system Combine.letpub=URLSession.shared.cx.dataTaskPublisher(for: url)#else // use system Combineletpub=URLSession.shared.dataTaskPublisher(for: url)#endif

WithCXShim, you don't need compilation flags anymore:

import CXShim// `cx` namespace is available even if you're using system Combineletpub=URLSession.shared.cx.dataTaskPublisher(for: url)

Yes you can!CXShim support every known Combine implementations and will support any future one. Just set environment variableCX_COMBINE_IMPLEMENTATION to their respective value. If your library is not listed below, feel free to open an issue.

Disclaimer: These project are not part of CombineX. They may have different consistent level with Apple's Combine thanwe promised, and not necessarily pass our test suit. We do not make any warranty of any kind for them.