README.md

TinkoffConcurrency

TL;DR

// Make URLSessionDataTask conform to TCCancellable
extension URLSessionDataTask: TCCancellable {}

func download(from url: URL) async throws -> Data {
    await withCheckedThrowingCancellableContinuation{ completion in
        let task = URLSession.shared.dataTask(with: URLRequest(url: url)) { data, _, error in
            if let data = data {
                completion(.success(data))
            } else if let error = error {
                completion(.failure(error))
            } else {
                completion(.failure(Errors.unknownError))
            }
        }

        task.resume()

        return task
    }
}

let channel = TCAsyncChannel<Int, Never>()
let filtered = channel
    .filter { $0 % 2 == 0 }

Task {
    // Available from iOS 13
    for await number in filtered.asyncValues {
        print("\(number)", terminator: " ")
    }
}

try await channel.send(1)
try await channel.send(2)
try await channel.send(3)

try channel.send(completion: .finished)

Requirements

TinkoffConcurrency requires Swift 5.5 and higher, with support of Swift Concurrency. This way, all Xcode versions starting from 13.0 would work. It's advisable to use Xcode at least 13.2.1 or higher, as it provides backward compatibility with iOS 13.0 and higher.

Installation

CocoaPods

TinkoffConcurrency is available through CocoaPods. To install it, simply add the following line to your Podfile:

pod 'TinkoffConcurrency'

Swift Package Manager

1. From File menu, select Add Packages...

2. Enter https://github.com/tinkoff-mobile-tech/TinkoffConcurrency into repository URL

3. Select Up to Next Major Version, and use 1.2.0 as a minimum version

4. Select your project in Add to Project and click Add Package

5. In opened dialog, choose target to add library to

Documentation

The documentation is available here:

• main
• 2.0.0

Old versions

• 1.1.0
• 1.2.0

Example

To run the example project, clone the repo, and run pod install from the Example directory first. Example app is a small demo that illustrates behavior of withCheckedThrowingCancellableContinuation for both cancellable and non-cancellable tasks, and compares that to vanilla withCheckedThrowingContinuation behavior.

Example application needs iOS 15.0 to run, as it uses new SwiftUI features. It does NOT imply any restrictions of using TinkoffConcurrency library on older iOS versions.

Authors

Timur Khamidov, [email protected]

Aleksandr Darovskikh, [email protected]

License

TinkoffConcurrency is available under the Apache 2.0 license. See the LICENSE file for more info.

Attributions

Thank you Point-free for test Combine scheduler