Revision control
Copy as Markdown
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
import Foundation
// TODO: Replace this with a class var
public var DeferredDefaultQueue = DispatchQueue.global(qos: .default)
open class Deferred<T> {
typealias UponBlock = (DispatchQueue, (T) -> Void)
private typealias Protected = (protectedValue: T?, uponBlocks: [UponBlock])
private var protected: LockProtected<Protected>
private let defaultQueue: DispatchQueue
public init(value: T? = nil, defaultQueue: DispatchQueue = DeferredDefaultQueue) {
protected = LockProtected(item: (value, []))
self.defaultQueue = defaultQueue
}
// Check whether or not the receiver is filled
public var isFilled: Bool {
return protected.withReadLock { $0.protectedValue != nil }
}
private func _fill(value: T, assertIfFilled: Bool) {
let (filledValue, blocks) = protected.withWriteLock { data -> (T, [UponBlock]) in
if assertIfFilled {
precondition(data.protectedValue == nil, "Cannot fill an already-filled Deferred")
data.protectedValue = value
} else if data.protectedValue == nil {
data.protectedValue = value
}
let blocks = data.uponBlocks
data.uponBlocks.removeAll(keepingCapacity: false)
return (data.protectedValue!, blocks)
}
for (queue, block) in blocks {
queue.async { block(filledValue) }
}
}
open func fill(_ value: T) {
_fill(value: value, assertIfFilled: true)
}
public func fillIfUnfilled(_ value: T) {
_fill(value: value, assertIfFilled: false)
}
public func peek() -> T? {
return protected.withReadLock { $0.protectedValue }
}
public func uponQueue(_ queue: DispatchQueue, block: @escaping (T) -> Void) {
let maybeValue: T? = protected.withWriteLock { data in
if data.protectedValue == nil {
data.uponBlocks.append( (queue, block) )
}
return data.protectedValue
}
if let value = maybeValue {
queue.async { block(value) }
}
}
}
extension Deferred {
public var value: T {
// fast path - return if already filled
if let v = peek() {
return v
}
// slow path - block until filled
let group = DispatchGroup()
var result: T!
group.enter()
self.upon { result = $0; group.leave() }
_ = group.wait(timeout: .distantFuture)
return result
}
}
extension Deferred {
public func bindQueue<U>(_ queue: DispatchQueue, f: @escaping (T) -> Deferred<U>) -> Deferred<U> {
let d = Deferred<U>()
self.uponQueue(queue) {
f($0).uponQueue(queue) {
d.fill($0)
}
}
return d
}
public func mapQueue<U>(_ queue: DispatchQueue, f: @escaping (T) -> U) -> Deferred<U> {
return bindQueue(queue) { t in Deferred<U>(value: f(t)) }
}
}
extension Deferred {
public func upon(_ block: @escaping (T) -> Void) {
uponQueue(defaultQueue, block: block)
}
public func bind<U>(_ f: @escaping (T) -> Deferred<U>) -> Deferred<U> {
return bindQueue(defaultQueue, f: f)
}
public func map<U>(_ f: @escaping (T) -> U) -> Deferred<U> {
return mapQueue(defaultQueue, f: f)
}
}
extension Deferred {
public func both<U>(_ other: Deferred<U>) -> Deferred<(T, U)> {
return self.bind { t in other.map { u in (t, u) } }
}
}
public func all<T>(_ deferreds: [Deferred<T>]) -> Deferred<[T]> {
if deferreds.isEmpty {
return Deferred(value: [])
}
let combined = Deferred<[T]>()
var results: [T] = []
results.reserveCapacity(deferreds.count)
var block: ((T) -> Void)!
block = { t in
results.append(t)
if results.count == deferreds.count {
combined.fill(results)
} else {
deferreds[results.count].upon(block)
}
}
deferreds[0].upon(block)
return combined
}
public func any<T>(_ deferreds: [Deferred<T>]) -> Deferred<Deferred<T>> {
let combined = Deferred<Deferred<T>>()
for d in deferreds {
d.upon { _ in combined.fillIfUnfilled(d) }
}
return combined
}