Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nghialv/future
Swift µframework providing Future<T, Error>
https://github.com/nghialv/future
Last synced: 19 days ago
JSON representation
Swift µframework providing Future<T, Error>
- Host: GitHub
- URL: https://github.com/nghialv/future
- Owner: nghialv
- License: mit
- Created: 2015-05-31T07:20:48.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2016-02-12T14:19:12.000Z (almost 9 years ago)
- Last Synced: 2024-10-31T02:33:34.480Z (21 days ago)
- Language: Swift
- Size: 2.17 MB
- Stars: 122
- Watchers: 5
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Future
=====
[](https://developer.apple.com/swift)
[]()
[]
(https://github.com/Carthage/Carthage)
[](http://mit-license.org)
[](https://github.com/nghialv/Future/issues?state=open)
Swift µframework providing Future<T, Error>.
This library is inspired by the [talk of Javier Soto](https://realm.io/news/swift-summit-javier-soto-futures/) at SwiftSubmit2015 and the `Future` implementation in Scala.
And this is using `antitypical/Result`.
### Why we need Future?
##### Traditional async code
``` swift
func requestRepository(repoId: Int64, completion: (Repository?, NSError?) -> Void) {}
func requestUser(userId: Int64, completion: (User?, NSError?) -> Void) {}
// get owner info of a given repository
requestRepository(12345) { repo, error in
if let repo = repo {
requestUser(repo.ownerId) { user, error in
if let user = user {
// do something
} else {
// error handling
}
}
} else {
// error handling
}
}
```
##### Code with Future
``` swift
let future = requestRepository(12345)
.map { $0.ownerId }
.flatMap(requestUser)
future.onCompleted { result in
switch result {
case .Success(let user): println(user)
case .Failure(let error): println(error)
}
}
```
**Shorthand by using operator**
``` swift
let future = requestRepository(12345) <^> { $0.ownerId } >>- requestUser
future.onCompleted { result in
switch result {
case .Success(let user): println(user)
case .Failure(let error): println(error)
}
}
```
Usage
-----
- `map` `<^>`
```swift
let f = requestUser("nghialv") <^> { $0.id }
f.onSuccess { userId in
println(userId)
}
```
- `flatMap` `>>-`
```swift
let f = searchRepositories("Hakuba") <^> { $0.first!.ownerName } >>- requestUser
f.onComplete { result in
switch result {
case .Success(let user): println(user)
case .Failure(let error): println(error)
}
}
```
- `filter`
``` swift
let e = NSError(domain: "noSuchElement", code: 1, userInfo: nil)
let f1 = searchRepositories("Hakuba")
let f = f1.filter(e){ $0.count > 0 } <^> { $0.first!.ownerName } >>- requestUser
f.onComplete { result in
switch result {
case .Success(let user): println(user)
case .Failure(let error): println(error)
}
}
```
- `andThen`
```swift
// side-effect
var reposCount = 0
let f1 = searchRepositories("Hakuba")
let f2 = f1.andThen { result in
switch result {
case .Success(let repos): reposCount = repos.value.count
case .Failure(let error): break
}
}
let f3 = f2 <^> { $0.first!.ownerName } >>- requestUser
f3.onComplete { result in
switch result {
case .Success(let user): println(user)
case .Failure(let error): println(error)
}
}
```
- `recover`
- `zip`
```swift
let f1 = searchRepositories("Future")
let f2 = requestUser("nghialv")
let f3 = f1.zip(f2)
f3.onSuccess { repos, user in
println(repos)
println(user)
}
```
- `flatten`
Installation
-----
- Using Carthage
> - Insert `github "nghialv/Future"` to your Cartfile
> - Run `carthage update`
- Using Cocoapods
> - Insert `use_frameworks!` to your Podfile
> - Insert `pod "Future"` to your Podfile
> - Run `pod install`
- Using Submodule
Requirements
-----
- Swift 1.2 (Xcode 6.3 or later)
- iOS 8.0 or later