| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976 |
- import Foundation
- import Result
- /// A SignalProducer creates Signals that can produce values of type `Value`
- /// and/or fail with errors of type `Error`. If no failure should be possible,
- /// `NoError` can be specified for `Error`.
- ///
- /// SignalProducers can be used to represent operations or tasks, like network
- /// requests, where each invocation of `start()` will create a new underlying
- /// operation. This ensures that consumers will receive the results, versus a
- /// plain Signal, where the results might be sent before any observers are
- /// attached.
- ///
- /// Because of the behavior of `start()`, different Signals created from the
- /// producer may see a different version of Events. The Events may arrive in a
- /// different order between Signals, or the stream might be completely
- /// different!
- public struct SignalProducer<Value, Error: ErrorType> {
- public typealias ProducedSignal = Signal<Value, Error>
- private let startHandler: (Signal<Value, Error>.Observer, CompositeDisposable) -> Void
- /// Initializes a `SignalProducer` that will emit the same events as the
- /// given signal.
- ///
- /// If the Disposable returned from `start()` is disposed or a terminating
- /// event is sent to the observer, the given signal will be disposed.
- ///
- /// - parameters:
- /// - signal: A signal to observe after starting the producer.
- public init<S: SignalType where S.Value == Value, S.Error == Error>(signal: S) {
- self.init { observer, disposable in
- disposable += signal.observe(observer)
- }
- }
- /// Initializes a SignalProducer that will invoke the given closure once for
- /// each invocation of `start()`.
- ///
- /// The events that the closure puts into the given observer will become
- /// the events sent by the started `Signal` to its observers.
- ///
- /// - note: If the `Disposable` returned from `start()` is disposed or a
- /// terminating event is sent to the observer, the given
- /// `CompositeDisposable` will be disposed, at which point work
- /// should be interrupted and any temporary resources cleaned up.
- ///
- /// - parameters:
- /// - startHandler: A closure that accepts observer and a disposable.
- public init(_ startHandler: (Signal<Value, Error>.Observer, CompositeDisposable) -> Void) {
- self.startHandler = startHandler
- }
- /// Creates a producer for a `Signal` that will immediately send one value
- /// then complete.
- ///
- /// - parameters:
- /// - value: A value that should be sent by the `Signal` in a `Next`
- /// event.
- public init(value: Value) {
- self.init { observer, disposable in
- observer.sendNext(value)
- observer.sendCompleted()
- }
- }
- /// Creates a producer for a `Signal` that will immediately fail with the
- /// given error.
- ///
- /// - parameters:
- /// - error: An error that should be sent by the `Signal` in a `Failed`
- /// event.
- public init(error: Error) {
- self.init { observer, disposable in
- observer.sendFailed(error)
- }
- }
- /// Creates a producer for a Signal that will immediately send one value
- /// then complete, or immediately fail, depending on the given Result.
- ///
- /// - parameters:
- /// - result: A `Result` instance that will send either `Next` event if
- /// `result` is `Success`ful or `Failed` event if `result` is a
- /// `Failure`.
- public init(result: Result<Value, Error>) {
- switch result {
- case let .Success(value):
- self.init(value: value)
- case let .Failure(error):
- self.init(error: error)
- }
- }
- /// Creates a producer for a Signal that will immediately send the values
- /// from the given sequence, then complete.
- ///
- /// - parameters:
- /// - values: A sequence of values that a `Signal` will send as separate
- /// `Next` events and then complete.
- public init<S: SequenceType where S.Generator.Element == Value>(values: S) {
- self.init { observer, disposable in
- for value in values {
- observer.sendNext(value)
- if disposable.disposed {
- break
- }
- }
- observer.sendCompleted()
- }
- }
-
- /// Creates a producer for a Signal that will immediately send the values
- /// from the given sequence, then complete.
- ///
- /// - parameters:
- /// - first: First value for the `Signal` to send.
- /// - second: Second value for the `Signal` to send.
- /// - tail: Rest of the values to be sent by the `Signal`.
- public init(values first: Value, _ second: Value, _ tail: Value...) {
- self.init(values: [ first, second ] + tail)
- }
- /// A producer for a Signal that will immediately complete without sending
- /// any values.
- public static var empty: SignalProducer {
- return self.init { observer, disposable in
- observer.sendCompleted()
- }
- }
- /// A producer for a Signal that never sends any events to its observers.
- public static var never: SignalProducer {
- return self.init { _ in return }
- }
- /// Create a queue for events that replays them when new signals are
- /// created from the returned producer.
- ///
- /// When values are put into the returned observer (observer), they will be
- /// added to an internal buffer. If the buffer is already at capacity, the
- /// earliest (oldest) value will be dropped to make room for the new value.
- ///
- /// Signals created from the returned producer will stay alive until a
- /// terminating event is added to the queue. If the queue does not contain
- /// such an event when the Signal is started, all values sent to the
- /// returned observer will be automatically forwarded to the Signal’s
- /// observers until a terminating event is received.
- ///
- /// - note: After a terminating event has been added to the queue, the
- /// observer will not add any further events. This _does not_ count
- /// against the value capacity so no buffered values will be dropped
- /// on termination.
- ///
- /// - precondition: `capacity` must be non-negative integer.
- ///
- /// - parameters:
- /// - capacity: Maximum number of values to buffer.
- ///
- /// - returns: A tuple of `SignalProducer` to replay values from and
- /// an `observer` to put replayable values to.
- @available(*, deprecated, message="Use properties instead. 'buffer' will be removed in RAC 5.0")
- public static func buffer(capacity: Int) -> (SignalProducer, Signal<Value, Error>.Observer) {
- precondition(capacity >= 0, "Invalid capacity: \(capacity)")
- // Used as an atomic variable so we can remove observers without needing
- // to run on a serial queue.
- let state: Atomic<BufferState<Value, Error>> = Atomic(BufferState())
- let producer = self.init { observer, disposable in
- // Assigned to when replay() is invoked synchronously below.
- var token: RemovalToken?
- let replayBuffer = ReplayBuffer<Value>()
- var replayValues: [Value] = []
- var replayToken: RemovalToken?
- var next = state.modify { state in
- var state = state
- replayValues = state.values
- if replayValues.isEmpty {
- token = state.observers?.insert(observer)
- } else {
- replayToken = state.replayBuffers.insert(replayBuffer)
- }
- return state
- }
- while !replayValues.isEmpty {
- replayValues.forEach(observer.sendNext)
- next = state.modify { state in
- var state = state
- replayValues = replayBuffer.values
- replayBuffer.values = []
- if replayValues.isEmpty {
- if let replayToken = replayToken {
- state.replayBuffers.removeValueForToken(replayToken)
- }
- token = state.observers?.insert(observer)
- }
- return state
- }
- }
- if let terminationEvent = next.terminationEvent {
- observer.action(terminationEvent)
- }
- if let token = token {
- disposable += {
- state.modify { state in
- var state = state
- state.observers?.removeValueForToken(token)
- return state
- }
- }
- }
- }
- let bufferingObserver: Signal<Value, Error>.Observer = Observer { event in
- let originalState = state.modify { state in
- var state = state
- if let value = event.value {
- state.addValue(value, upToCapacity: capacity)
- } else {
- // Disconnect all observers and prevent future
- // attachments.
- state.terminationEvent = event
- state.observers = nil
- }
- return state
- }
- originalState.observers?.forEach { $0.action(event) }
- }
- return (producer, bufferingObserver)
- }
- /// Create a `SignalProducer` that will attempt the given operation once for
- /// each invocation of `start()`.
- ///
- /// Upon success, the started signal will send the resulting value then
- /// complete. Upon failure, the started signal will fail with the error that
- /// occurred.
- ///
- /// - parameters:
- /// - operation: A closure that returns instance of `Result`.
- ///
- /// - returns: A `SignalProducer` that will forward `Success`ful `result` as
- /// `Next` event and then complete or `Failed` event if `result`
- /// is a `Failure`.
- public static func attempt(operation: () -> Result<Value, Error>) -> SignalProducer {
- return self.init { observer, disposable in
- operation().analysis(ifSuccess: { value in
- observer.sendNext(value)
- observer.sendCompleted()
- }, ifFailure: { error in
- observer.sendFailed(error)
- })
- }
- }
- /// Create a Signal from the producer, pass it into the given closure,
- /// then start sending events on the Signal when the closure has returned.
- ///
- /// The closure will also receive a disposable which can be used to
- /// interrupt the work associated with the signal and immediately send an
- /// `Interrupted` event.
- ///
- /// - parameters:
- /// - setUp: A closure that accepts a `signal` and `disposable`.
- public func startWithSignal(@noescape setUp: (Signal<Value, Error>, Disposable) -> Void) {
- let (signal, observer) = Signal<Value, Error>.pipe()
- // Disposes of the work associated with the SignalProducer and any
- // upstream producers.
- let producerDisposable = CompositeDisposable()
- // Directly disposed of when `start()` or `startWithSignal()` is
- // disposed.
- let cancelDisposable = ActionDisposable {
- observer.sendInterrupted()
- producerDisposable.dispose()
- }
- setUp(signal, cancelDisposable)
- if cancelDisposable.disposed {
- return
- }
- let wrapperObserver: Signal<Value, Error>.Observer = Observer { event in
- observer.action(event)
- if event.isTerminating {
- // Dispose only after notifying the Signal, so disposal
- // logic is consistently the last thing to run.
- producerDisposable.dispose()
- }
- }
- startHandler(wrapperObserver, producerDisposable)
- }
- }
- /// A uniquely identifying token for Observers that are replaying values in
- /// BufferState.
- private final class ReplayBuffer<Value> {
- private var values: [Value] = []
- }
- private struct BufferState<Value, Error: ErrorType> {
- /// All values in the buffer.
- var values: [Value] = []
- /// Any terminating event sent to the buffer.
- ///
- /// This will be nil if termination has not occurred.
- var terminationEvent: Event<Value, Error>?
- /// The observers currently attached to the buffered producer, or nil if the
- /// producer was terminated.
- var observers: Bag<Signal<Value, Error>.Observer>? = Bag()
- /// The set of unused replay token identifiers.
- var replayBuffers: Bag<ReplayBuffer<Value>> = Bag()
- /// Appends a new value to the buffer, trimming it down to the given
- /// capacity if necessary.
- mutating func addValue(value: Value, upToCapacity capacity: Int) {
- precondition(capacity >= 0)
- for buffer in replayBuffers {
- buffer.values.append(value)
- }
- if capacity == 0 {
- values = []
- return
- }
- if capacity == 1 {
- values = [ value ]
- return
- }
- values.append(value)
- let overflow = values.count - capacity
- if overflow > 0 {
- values.removeRange(0..<overflow)
- }
- }
- }
- public protocol SignalProducerType {
- /// The type of values being sent on the producer
- associatedtype Value
- /// The type of error that can occur on the producer. If errors aren't
- /// possible then `NoError` can be used.
- associatedtype Error: ErrorType
- /// Extracts a signal producer from the receiver.
- var producer: SignalProducer<Value, Error> { get }
- /// Creates a Signal from the producer, passes it into the given closure,
- /// then starts sending events on the Signal when the closure has returned.
- func startWithSignal(@noescape setUp: (Signal<Value, Error>, Disposable) -> Void)
- }
- extension SignalProducer: SignalProducerType {
- public var producer: SignalProducer {
- return self
- }
- }
- extension SignalProducerType {
- /// Create a Signal from the producer, then attach the given observer to
- /// the `Signal` as an observer.
- ///
- /// - parameters:
- /// - observer: An observer to attach to produced signal.
- ///
- /// - returns: A `Disposable` which can be used to interrupt the work
- /// associated with the signal and immediately send an
- /// `Interrupted` event.
- public func start(observer: Signal<Value, Error>.Observer = Signal<Value, Error>.Observer()) -> Disposable {
- var disposable: Disposable!
- startWithSignal { signal, innerDisposable in
- signal.observe(observer)
- disposable = innerDisposable
- }
- return disposable
- }
- /// Convenience override for start(_:) to allow trailing-closure style
- /// invocations.
- ///
- /// - parameters:
- /// - observerAction: A closure that accepts `Event` sent by the produced
- /// signal.
- ///
- /// - returns: A `Disposable` which can be used to interrupt the work
- /// associated with the signal and immediately send an
- /// `Interrupted` event.
- public func start(observerAction: Signal<Value, Error>.Observer.Action) -> Disposable {
- return start(Observer(observerAction))
- }
- @available(*, deprecated, message="This SignalProducer may emit errors which must be handled explicitly, or observed using startWithResult:")
- public func startWithNext(next: Value -> Void) -> Disposable {
- return start(Observer(next: next))
- }
- /// Create a Signal from the producer, then add an observer to the `Signal`,
- /// which will invoke the given callback when `Next` or `Failed` events are
- /// received.
- ///
- /// - parameters:
- /// - result: A closure that accepts a `result` that contains a `Success`
- /// case for `Next` events or `Failure` case for `Failed` event.
- ///
- /// - returns: A Disposable which can be used to interrupt the work
- /// associated with the Signal, and prevent any future callbacks
- /// from being invoked.
- public func startWithResult(result: Result<Value, Error> -> Void) -> Disposable {
- return start(
- Observer(
- next: { result(.Success($0)) },
- failed: { result(.Failure($0)) }
- )
- )
- }
- /// Create a Signal from the producer, then add exactly one observer to the
- /// Signal, which will invoke the given callback when a `Completed` event is
- /// received.
- ///
- /// - parameters:
- /// - completed: A closure that will be envoked when produced signal sends
- /// `Completed` event.
- ///
- /// - returns: A `Disposable` which can be used to interrupt the work
- /// associated with the signal.
- public func startWithCompleted(completed: () -> Void) -> Disposable {
- return start(Observer(completed: completed))
- }
-
- /// Creates a Signal from the producer, then adds exactly one observer to
- /// the Signal, which will invoke the given callback when a `failed` event
- /// is received.
- ///
- /// - parameters:
- /// - failed: A closure that accepts an error object.
- ///
- /// - returns: A `Disposable` which can be used to interrupt the work
- /// associated with the signal.
- public func startWithFailed(failed: Error -> Void) -> Disposable {
- return start(Observer(failed: failed))
- }
-
- /// Creates a Signal from the producer, then adds exactly one observer to
- /// the Signal, which will invoke the given callback when an `Interrupted`
- /// event is received.
- ///
- /// - parameters:
- /// - interrupted: A closure that is invoked when `Interrupted` event is
- /// received.
- ///
- /// - returns: A `Disposable` which can be used to interrupt the work
- /// associated with the signal.
- public func startWithInterrupted(interrupted: () -> Void) -> Disposable {
- return start(Observer(interrupted: interrupted))
- }
- }
- extension SignalProducerType where Error == NoError {
- /// Create a Signal from the producer, then add exactly one observer to
- /// the Signal, which will invoke the given callback when `Next` events are
- /// received.
- ///
- /// - parameters:
- /// - next: A closure that accepts a value carried by `Next` event.
- ///
- /// - returns: A `Disposable` which can be used to interrupt the work
- /// associated with the Signal, and prevent any future callbacks
- /// from being invoked.
- public func startWithNext(next: Value -> Void) -> Disposable {
- return start(Observer(next: next))
- }
- }
- extension SignalProducerType {
- /// Lift an unary Signal operator to operate upon SignalProducers instead.
- ///
- /// In other words, this will create a new `SignalProducer` which will apply
- /// the given `Signal` operator to _every_ created `Signal`, just as if the
- /// operator had been applied to each `Signal` yielded from `start()`.
- ///
- /// - parameters:
- /// - transform: An unary operator to lift.
- ///
- /// - returns: A signal producer that applies signal's operator to every
- /// created signal.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func lift<U, F>(transform: Signal<Value, Error> -> Signal<U, F>) -> SignalProducer<U, F> {
- return SignalProducer { observer, outerDisposable in
- self.startWithSignal { signal, innerDisposable in
- outerDisposable.addDisposable(innerDisposable)
- transform(signal).observe(observer)
- }
- }
- }
- /// Lift a binary Signal operator to operate upon SignalProducers instead.
- ///
- /// In other words, this will create a new `SignalProducer` which will apply
- /// the given `Signal` operator to _every_ `Signal` created from the two
- /// producers, just as if the operator had been applied to each `Signal`
- /// yielded from `start()`.
- ///
- /// - note: starting the returned producer will start the receiver of the
- /// operator, which may not be adviseable for some operators.
- ///
- /// - parameters:
- /// - transform: A binary operator to lift.
- ///
- /// - returns: A binary operator that operates on two signal producers.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func lift<U, F, V, G>(transform: Signal<Value, Error> -> Signal<U, F> -> Signal<V, G>) -> SignalProducer<U, F> -> SignalProducer<V, G> {
- return liftRight(transform)
- }
- /// Right-associative lifting of a binary signal operator over producers.
- /// That is, the argument producer will be started before the receiver. When
- /// both producers are synchronous this order can be important depending on
- /// the operator to generate correct results.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- private func liftRight<U, F, V, G>(transform: Signal<Value, Error> -> Signal<U, F> -> Signal<V, G>) -> SignalProducer<U, F> -> SignalProducer<V, G> {
- return { otherProducer in
- return SignalProducer { observer, outerDisposable in
- self.startWithSignal { signal, disposable in
- outerDisposable.addDisposable(disposable)
- otherProducer.startWithSignal { otherSignal, otherDisposable in
- outerDisposable.addDisposable(otherDisposable)
- transform(signal)(otherSignal).observe(observer)
- }
- }
- }
- }
- }
- /// Left-associative lifting of a binary signal operator over producers.
- /// That is, the receiver will be started before the argument producer. When
- /// both producers are synchronous this order can be important depending on
- /// the operator to generate correct results.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- private func liftLeft<U, F, V, G>(transform: Signal<Value, Error> -> Signal<U, F> -> Signal<V, G>) -> SignalProducer<U, F> -> SignalProducer<V, G> {
- return { otherProducer in
- return SignalProducer { observer, outerDisposable in
- otherProducer.startWithSignal { otherSignal, otherDisposable in
- outerDisposable.addDisposable(otherDisposable)
-
- self.startWithSignal { signal, disposable in
- outerDisposable.addDisposable(disposable)
- transform(signal)(otherSignal).observe(observer)
- }
- }
- }
- }
- }
- /// Lift a binary Signal operator to operate upon a Signal and a
- /// SignalProducer instead.
- ///
- /// In other words, this will create a new `SignalProducer` which will apply
- /// the given `Signal` operator to _every_ `Signal` created from the two
- /// producers, just as if the operator had been applied to each `Signal`
- /// yielded from `start()`.
- ///
- /// - parameters:
- /// - transform: A binary operator to lift.
- ///
- /// - returns: A binary operator that works on `Signal` and returns
- /// `SignalProducer`.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func lift<U, F, V, G>(transform: Signal<Value, Error> -> Signal<U, F> -> Signal<V, G>) -> Signal<U, F> -> SignalProducer<V, G> {
- return { otherSignal in
- return SignalProducer { observer, outerDisposable in
- let (wrapperSignal, otherSignalObserver) = Signal<U, F>.pipe()
- // Avoid memory leak caused by the direct use of the given
- // signal.
- //
- // See https://github.com/ReactiveCocoa/ReactiveCocoa/pull/2758
- // for the details.
- outerDisposable += ActionDisposable {
- otherSignalObserver.sendInterrupted()
- }
- outerDisposable += otherSignal.observe(otherSignalObserver)
- self.startWithSignal { signal, disposable in
- outerDisposable += disposable
- outerDisposable += transform(signal)(wrapperSignal).observe(observer)
- }
- }
- }
- }
-
- /// Map each value in the producer to a new value.
- ///
- /// - parameters:
- /// - transform: A closure that accepts a value and returns a different
- /// value.
- ///
- /// - returns: A signal producer that, when started, will send a mapped
- /// value of `self.`
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func map<U>(transform: Value -> U) -> SignalProducer<U, Error> {
- return lift { $0.map(transform) }
- }
- /// Map errors in the producer to a new error.
- ///
- /// - parameters:
- /// - transform: A closure that accepts an error object and returns a
- /// different error.
- ///
- /// - returns: A producer that emits errors of new type.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func mapError<F>(transform: Error -> F) -> SignalProducer<Value, F> {
- return lift { $0.mapError(transform) }
- }
- /// Preserve only the values of the producer that pass the given predicate.
- ///
- /// - parameters:
- /// - predicate: A closure that accepts value and returns `Bool` denoting
- /// whether value has passed the test.
- ///
- /// - returns: A producer that, when started, will send only the values
- /// passing the given predicate.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func filter(predicate: Value -> Bool) -> SignalProducer<Value, Error> {
- return lift { $0.filter(predicate) }
- }
- /// Yield the first `count` values from the input producer.
- ///
- /// - precondition: `count` must be non-negative number.
- ///
- /// - parameters:
- /// - count: A number of values to take from the signal.
- ///
- /// - returns: A producer that, when started, will yield the first `count`
- /// values from `self`.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func take(count: Int) -> SignalProducer<Value, Error> {
- return lift { $0.take(count) }
- }
- /// Yield an array of values when `self` completes.
- ///
- /// - note: When `self` completes without collecting any value, it will send
- /// an empty array of values.
- ///
- /// - returns: A producer that, when started, will yield an array of values
- /// when `self` completes.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func collect() -> SignalProducer<[Value], Error> {
- return lift { $0.collect() }
- }
- /// Yield an array of values until it reaches a certain count.
- ///
- /// - precondition: `count` should be greater than zero.
- ///
- /// - note: When the count is reached the array is sent and the signal
- /// starts over yielding a new array of values.
- ///
- /// - note: When `self` completes any remaining values will be sent, the
- /// last array may not have `count` values. Alternatively, if were
- /// not collected any values will sent an empty array of values.
- ///
- /// - returns: A producer that, when started, collects at most `count`
- /// values from `self`, forwards them as a single array and
- /// completes.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func collect(count count: Int) -> SignalProducer<[Value], Error> {
- precondition(count > 0)
- return lift { $0.collect(count: count) }
- }
- /// Yield an array of values based on a predicate which matches the values
- /// collected.
- ///
- /// - note: When `self` completes any remaining values will be sent, the
- /// last array may not match `predicate`. Alternatively, if were not
- /// collected any values will sent an empty array of values.
- ///
- /// ````
- /// let (producer, observer) = SignalProducer<Int, NoError>.buffer(1)
- ///
- /// producer
- /// .collect { values in values.reduce(0, combine: +) == 8 }
- /// .startWithNext { print($0) }
- ///
- /// observer.sendNext(1)
- /// observer.sendNext(3)
- /// observer.sendNext(4)
- /// observer.sendNext(7)
- /// observer.sendNext(1)
- /// observer.sendNext(5)
- /// observer.sendNext(6)
- /// observer.sendCompleted()
- ///
- /// // Output:
- /// // [1, 3, 4]
- /// // [7, 1]
- /// // [5, 6]
- /// ````
- ///
- /// - parameters:
- /// - predicate: Predicate to match when values should be sent (returning
- /// `true`) or alternatively when they should be collected
- /// (where it should return `false`). The most recent value
- /// (`next`) is included in `values` and will be the end of
- /// the current array of values if the predicate returns
- /// `true`.
- ///
- /// - returns: A producer that, when started, collects values passing the
- /// predicate and, when `self` completes, forwards them as a
- /// single array and complets.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func collect(predicate: (values: [Value]) -> Bool) -> SignalProducer<[Value], Error> {
- return lift { $0.collect(predicate) }
- }
- /// Yield an array of values based on a predicate which matches the values
- /// collected and the next value.
- ///
- /// - note: When `self` completes any remaining values will be sent, the
- /// last array may not match `predicate`. Alternatively, if no
- /// values were collected an empty array will be sent.
- ///
- /// ````
- /// let (producer, observer) = SignalProducer<Int, NoError>.buffer(1)
- ///
- /// producer
- /// .collect { values, next in next == 7 }
- /// .startWithNext { print($0) }
- ///
- /// observer.sendNext(1)
- /// observer.sendNext(1)
- /// observer.sendNext(7)
- /// observer.sendNext(7)
- /// observer.sendNext(5)
- /// observer.sendNext(6)
- /// observer.sendCompleted()
- ///
- /// // Output:
- /// // [1, 1]
- /// // [7]
- /// // [7, 5, 6]
- /// ````
- ///
- /// - parameters:
- /// - predicate: Predicate to match when values should be sent (returning
- /// `true`) or alternatively when they should be collected
- /// (where it should return `false`). The most recent value
- /// (`next`) is not included in `values` and will be the
- /// start of the next array of values if the predicate
- /// returns `true`.
- ///
- /// - returns: A signal that will yield an array of values based on a
- /// predicate which matches the values collected and the next
- /// value.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func collect(predicate: (values: [Value], next: Value) -> Bool) -> SignalProducer<[Value], Error> {
- return lift { $0.collect(predicate) }
- }
- /// Forward all events onto the given scheduler, instead of whichever
- /// scheduler they originally arrived upon.
- ///
- /// - parameters:
- /// - scheduler: A scheduler to deliver events on.
- ///
- /// - returns: A producer that, when started, will yield `self` values on
- /// provided scheduler.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func observeOn(scheduler: SchedulerType) -> SignalProducer<Value, Error> {
- return lift { $0.observeOn(scheduler) }
- }
- /// Combine the latest value of the receiver with the latest value from the
- /// given producer.
- ///
- /// - note: The returned producer will not send a value until both inputs
- /// have sent at least one value each.
- ///
- /// - note: If either producer is interrupted, the returned producer will
- /// also be interrupted.
- ///
- /// - parameters:
- /// - otherProducer: A producer to combine `self`'s value with.
- ///
- /// - returns: A producer that, when started, will yield a tuple containing
- /// values of `self` and given producer.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func combineLatestWith<U>(otherProducer: SignalProducer<U, Error>) -> SignalProducer<(Value, U), Error> {
- // This should be the implementation of this method:
- // return liftRight(Signal.combineLatestWith)(otherProducer)
- //
- // However, due to a Swift miscompilation (with `-O`) we need to inline `liftRight` here.
- // See https://github.com/ReactiveCocoa/ReactiveCocoa/issues/2751 for more details.
- //
- // This can be reverted once tests with -O don't crash.
- return SignalProducer { observer, outerDisposable in
- self.startWithSignal { signal, disposable in
- outerDisposable.addDisposable(disposable)
- otherProducer.startWithSignal { otherSignal, otherDisposable in
- outerDisposable.addDisposable(otherDisposable)
- signal.combineLatestWith(otherSignal).observe(observer)
- }
- }
- }
- }
- /// Combine the latest value of the receiver with the latest value from
- /// the given signal.
- ///
- /// - note: The returned producer will not send a value until both inputs
- /// have sent at least one value each.
- ///
- /// - note: If either input is interrupted, the returned producer will also
- /// be interrupted.
- ///
- /// - parameters:
- /// - otherSignal: A signal to combine `self`'s value with.
- ///
- /// - returns: A producer that, when started, will yield a tuple containing
- /// values of `self` and given signal.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func combineLatestWith<U>(otherSignal: Signal<U, Error>) -> SignalProducer<(Value, U), Error> {
- return lift(Signal.combineLatestWith)(otherSignal)
- }
- /// Delay `Next` and `Completed` events by the given interval, forwarding
- /// them on the given scheduler.
- ///
- /// - note: `Failed` and `Interrupted` events are always scheduled
- /// immediately.
- ///
- /// - parameters:
- /// - interval: Interval to delay `Next` and `Completed` events by.
- /// - scheduler: A scheduler to deliver delayed events on.
- ///
- /// - returns: A producer that, when started, will delay `Next` and
- /// `Completed` events and will yield them on given scheduler.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func delay(interval: NSTimeInterval, onScheduler scheduler: DateSchedulerType) -> SignalProducer<Value, Error> {
- return lift { $0.delay(interval, onScheduler: scheduler) }
- }
- /// Skip the first `count` values, then forward everything afterward.
- ///
- /// - parameters:
- /// - count: A number of values to skip.
- ///
- /// - returns: A producer that, when started, will skip the first `count`
- /// values, then forward everything afterward.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func skip(count: Int) -> SignalProducer<Value, Error> {
- return lift { $0.skip(count) }
- }
- /// Treats all Events from the input producer as plain values, allowing them
- /// to be manipulated just like any other value.
- ///
- /// In other words, this brings Events “into the monad.”
- ///
- /// - note: When a Completed or Failed event is received, the resulting
- /// producer will send the Event itself and then complete. When an
- /// `Interrupted` event is received, the resulting producer will
- /// send the `Event` itself and then interrupt.
- ///
- /// - returns: A producer that sends events as its values.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func materialize() -> SignalProducer<Event<Value, Error>, NoError> {
- return lift { $0.materialize() }
- }
- /// Forward the latest value from `self` with the value from `sampler` as a
- /// tuple, only when `sampler` sends a `Next` event.
- ///
- /// - note: If `sampler` fires before a value has been observed on `self`,
- /// nothing happens.
- ///
- /// - parameters:
- /// - sampler: A producer that will trigger the delivery of `Next` event
- /// from `self`.
- ///
- /// - returns: A producer that will send values from `self` and `sampler`,
- /// sampled (possibly multiple times) by `sampler`, then complete
- /// once both input producers have completed, or interrupt if
- /// either input producer is interrupted.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func sampleWith<T>(sampler: SignalProducer<T, NoError>) -> SignalProducer<(Value, T), Error> {
- return liftLeft(Signal.sampleWith)(sampler)
- }
-
- /// Forward the latest value from `self` with the value from `sampler` as a
- /// tuple, only when `sampler` sends a `Next` event.
- ///
- /// - note: If `sampler` fires before a value has been observed on `self`,
- /// nothing happens.
- ///
- /// - parameters:
- /// - sampler: A signal that will trigger the delivery of `Next` event
- /// from `self`.
- ///
- /// - returns: A producer that, when started, will send values from `self`
- /// and `sampler`, sampled (possibly multiple times) by
- /// `sampler`, then complete once both input producers have
- /// completed, or interrupt if either input producer is
- /// interrupted.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func sampleWith<T>(sampler: Signal<T, NoError>) -> SignalProducer<(Value, T), Error> {
- return lift(Signal.sampleWith)(sampler)
- }
- /// Forward the latest value from `self` whenever `sampler` sends a `Next`
- /// event.
- ///
- /// - note: If `sampler` fires before a value has been observed on `self`,
- /// nothing happens.
- ///
- /// - parameters:
- /// - sampler: A producer that will trigger the delivery of `Next` event
- /// from `self`.
- ///
- /// - returns: A producer that, when started, will send values from `self`,
- /// sampled (possibly multiple times) by `sampler`, then complete
- /// once both input producers have completed, or interrupt if
- /// either input producer is interrupted.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func sampleOn(sampler: SignalProducer<(), NoError>) -> SignalProducer<Value, Error> {
- return liftLeft(Signal.sampleOn)(sampler)
- }
- /// Forward the latest value from `self` whenever `sampler` sends a `Next`
- /// event.
- ///
- /// - note: If `sampler` fires before a value has been observed on `self`,
- /// nothing happens.
- ///
- /// - parameters:
- /// - trigger: A signal whose `Next` or `Completed` events will start the
- /// deliver of events on `self`.
- ///
- /// - returns: A producer that will send values from `self`, sampled
- /// (possibly multiple times) by `sampler`, then complete once
- /// both inputs have completed, or interrupt if either input is
- /// interrupted.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func sampleOn(sampler: Signal<(), NoError>) -> SignalProducer<Value, Error> {
- return lift(Signal.sampleOn)(sampler)
- }
- /// Forward events from `self` until `trigger` sends a `Next` or `Completed`
- /// event, at which point the returned producer will complete.
- ///
- /// - parameters:
- /// - trigger: A producer whose `Next` or `Completed` events will stop the
- /// delivery of `Next` events from `self`.
- ///
- /// - returns: A producer that will deliver events until `trigger` sends
- /// `Next` or `Completed` events.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func takeUntil(trigger: SignalProducer<(), NoError>) -> SignalProducer<Value, Error> {
- // This should be the implementation of this method:
- // return liftRight(Signal.takeUntil)(trigger)
- //
- // However, due to a Swift miscompilation (with `-O`) we need to inline
- // `liftRight` here.
- //
- // See https://github.com/ReactiveCocoa/ReactiveCocoa/issues/2751 for
- // more details.
- //
- // This can be reverted once tests with -O work correctly.
- return SignalProducer { observer, outerDisposable in
- self.startWithSignal { signal, disposable in
- outerDisposable.addDisposable(disposable)
- trigger.startWithSignal { triggerSignal, triggerDisposable in
- outerDisposable.addDisposable(triggerDisposable)
- signal.takeUntil(triggerSignal).observe(observer)
- }
- }
- }
- }
- /// Forward events from `self` until `trigger` sends a Next or Completed
- /// event, at which point the returned producer will complete.
- ///
- /// - parameters:
- /// - trigger: A signal whose `Next` or `Completed` events will stop the
- /// delivery of `Next` events from `self`.
- ///
- /// - returns: A producer that will deliver events until `trigger` sends
- /// `Next` or `Completed` events.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func takeUntil(trigger: Signal<(), NoError>) -> SignalProducer<Value, Error> {
- return lift(Signal.takeUntil)(trigger)
- }
- /// Do not forward any values from `self` until `trigger` sends a `Next`
- /// or `Completed`, at which point the returned producer behaves exactly
- /// like `producer`.
- ///
- /// - parameters:
- /// - trigger: A producer whose `Next` or `Completed` events will start
- /// the deliver of events on `self`.
- ///
- /// - returns: A producer that will deliver events once the `trigger` sends
- /// `Next` or `Completed` events.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func skipUntil(trigger: SignalProducer<(), NoError>) -> SignalProducer<Value, Error> {
- return liftRight(Signal.skipUntil)(trigger)
- }
-
- /// Do not forward any values from `self` until `trigger` sends a `Next`
- /// or `Completed`, at which point the returned signal behaves exactly like
- /// `signal`.
- ///
- /// - parameters:
- /// - trigger: A signal whose `Next` or `Completed` events will start the
- /// deliver of events on `self`.
- ///
- /// - returns: A producer that will deliver events once the `trigger` sends
- /// `Next` or `Completed` events.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func skipUntil(trigger: Signal<(), NoError>) -> SignalProducer<Value, Error> {
- return lift(Signal.skipUntil)(trigger)
- }
-
- /// Forward events from `self` with history: values of the returned producer
- /// are a tuple whose first member is the previous value and whose second
- /// member is the current value. `initial` is supplied as the first member
- /// when `self` sends its first value.
- ///
- /// - parameters:
- /// - initial: A value that will be combined with the first value sent by
- /// `self`.
- ///
- /// - returns: A producer that sends tuples that contain previous and
- /// current sent values of `self`.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func combinePrevious(initial: Value) -> SignalProducer<(Value, Value), Error> {
- return lift { $0.combinePrevious(initial) }
- }
- /// Send only the final value and then immediately completes.
- ///
- /// - parameters:
- /// - initial: Initial value for the accumulator.
- /// - combine: A closure that accepts accumulator and sent value of
- /// `self`.
- ///
- /// - returns: A producer that sends accumulated value after `self`
- /// completes.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func reduce<U>(initial: U, _ combine: (U, Value) -> U) -> SignalProducer<U, Error> {
- return lift { $0.reduce(initial, combine) }
- }
- /// Aggregate `self`'s values into a single combined value. When `self`
- /// emits its first value, `combine` is invoked with `initial` as the first
- /// argument and that emitted value as the second argument. The result is
- /// emitted from the producer returned from `scan`. That result is then
- /// passed to `combine` as the first argument when the next value is
- /// emitted, and so on.
- ///
- /// - parameters:
- /// - initial: Initial value for the accumulator.
- /// - combine: A closure that accepts accumulator and sent value of
- /// `self`.
- ///
- /// - returns: A producer that sends accumulated value each time `self`
- /// emits own value.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func scan<U>(initial: U, _ combine: (U, Value) -> U) -> SignalProducer<U, Error> {
- return lift { $0.scan(initial, combine) }
- }
- /// Forward only those values from `self` which do not pass `isRepeat` with
- /// respect to the previous value.
- ///
- /// - note: The first value is always forwarded.
- ///
- /// - returns: A producer that does not send two equal values sequentially.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func skipRepeats(isRepeat: (Value, Value) -> Bool) -> SignalProducer<Value, Error> {
- return lift { $0.skipRepeats(isRepeat) }
- }
- /// Do not forward any values from `self` until `predicate` returns false,
- /// at which point the returned producer behaves exactly like `self`.
- ///
- /// - parameters:
- /// - predicate: A closure that accepts a value and returns whether `self`
- /// should still not forward that value to a `producer`.
- ///
- /// - returns: A producer that sends only forwarded values from `self`.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func skipWhile(predicate: Value -> Bool) -> SignalProducer<Value, Error> {
- return lift { $0.skipWhile(predicate) }
- }
- /// Forward events from `self` until `replacement` begins sending events.
- ///
- /// - parameters:
- /// - replacement: A producer to wait to wait for values from and start
- /// sending them as a replacement to `self`'s values.
- ///
- /// - returns: A producer which passes through `Next`, `Failed`, and
- /// `Interrupted` events from `self` until `replacement` sends an
- /// event, at which point the returned producer will send that
- /// event and switch to passing through events from `replacement`
- /// instead, regardless of whether `self` has sent events
- /// already.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func takeUntilReplacement(replacement: SignalProducer<Value, Error>) -> SignalProducer<Value, Error> {
- return liftRight(Signal.takeUntilReplacement)(replacement)
- }
- /// Forwards events from `self` until `replacement` begins sending events.
- ///
- /// - parameters:
- /// - replacement: A signal to wait to wait for values from and start
- /// sending them as a replacement to `self`'s values.
- ///
- /// - returns: A producer which passes through `Next`, `Failed`, and
- /// `Interrupted` events from `self` until `replacement` sends an
- /// event, at which point the returned producer will send that
- /// event and switch to passing through events from `replacement`
- /// instead, regardless of whether `self` has sent events
- /// already.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func takeUntilReplacement(replacement: Signal<Value, Error>) -> SignalProducer<Value, Error> {
- return lift(Signal.takeUntilReplacement)(replacement)
- }
- /// Wait until `self` completes and then forward the final `count` values
- /// on the returned producer.
- ///
- /// - parameters:
- /// - count: Number of last events to send after `self` completes.
- ///
- /// - returns: A producer that receives up to `count` values from `self`
- /// after `self` completes.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func takeLast(count: Int) -> SignalProducer<Value, Error> {
- return lift { $0.takeLast(count) }
- }
- /// Forward any values from `self` until `predicate` returns false, at which
- /// point the returned producer will complete.
- ///
- /// - parameters:
- /// - predicate: A closure that accepts value and returns `Bool` value
- /// whether `self` should forward it to `signal` and continue
- /// sending other events.
- ///
- /// - returns: A producer that sends events until the values sent by `self`
- /// pass the given `predicate`.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func takeWhile(predicate: Value -> Bool) -> SignalProducer<Value, Error> {
- return lift { $0.takeWhile(predicate) }
- }
- /// Zip elements of two producers into pairs. The elements of any Nth pair
- /// are the Nth elements of the two input producers.
- ///
- /// - parameters:
- /// - otherProducer: A producer to zip values with.
- ///
- /// - returns: A producer that sends tuples of `self` and `otherProducer`.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func zipWith<U>(otherProducer: SignalProducer<U, Error>) -> SignalProducer<(Value, U), Error> {
- return liftRight(Signal.zipWith)(otherProducer)
- }
- /// Zip elements of this producer and a signal into pairs. The elements of
- /// any Nth pair are the Nth elements of the two.
- ///
- /// - parameters:
- /// - otherSignal: A signal to zip values with.
- ///
- /// - returns: A producer that sends tuples of `self` and `otherSignal`.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func zipWith<U>(otherSignal: Signal<U, Error>) -> SignalProducer<(Value, U), Error> {
- return lift(Signal.zipWith)(otherSignal)
- }
- /// Apply `operation` to values from `self` with `Success`ful results
- /// forwarded on the returned producer and `Failure`s sent as `Failed`
- /// events.
- ///
- /// - parameters:
- /// - operation: A closure that accepts a value and returns a `Result`.
- ///
- /// - returns: A producer that receives `Success`ful `Result` as `Next`
- /// event and `Failure` as `Failed` event.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func attempt(operation: Value -> Result<(), Error>) -> SignalProducer<Value, Error> {
- return lift { $0.attempt(operation) }
- }
- /// Apply `operation` to values from `self` with `Success`ful results
- /// mapped on the returned producer and `Failure`s sent as `Failed` events.
- ///
- /// - parameters:
- /// - operation: A closure that accepts a value and returns a result of
- /// a mapped value as `Success`.
- ///
- /// - returns: A producer that sends mapped values from `self` if returned
- /// `Result` is `Success`ful, `Failed` events otherwise.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func attemptMap<U>(operation: Value -> Result<U, Error>) -> SignalProducer<U, Error> {
- return lift { $0.attemptMap(operation) }
- }
- /// Throttle values sent by the receiver, so that at least `interval`
- /// seconds pass between each, then forwards them on the given scheduler.
- ///
- /// - note: If multiple values are received before the interval has elapsed,
- /// the latest value is the one that will be passed on.
- ///
- /// - norw: If `self` terminates while a value is being throttled, that
- /// value will be discarded and the returned producer will terminate
- /// immediately.
- ///
- /// - parameters:
- /// - interval: Number of seconds to wait between sent values.
- /// - scheduler: A scheduler to deliver events on.
- ///
- /// - returns: A producer that sends values at least `interval` seconds
- /// appart on a given scheduler.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func throttle(interval: NSTimeInterval, onScheduler scheduler: DateSchedulerType) -> SignalProducer<Value, Error> {
- return lift { $0.throttle(interval, onScheduler: scheduler) }
- }
- /// Debounce values sent by the receiver, such that at least `interval`
- /// seconds pass after the receiver has last sent a value, then
- /// forward the latest value on the given scheduler.
- ///
- /// - note: If multiple values are received before the interval has elapsed,
- /// the latest value is the one that will be passed on.
- ///
- /// - note: If `self` terminates while a value is being debounced,
- /// that value will be discarded and the returned producer will
- /// terminate immediately.
- ///
- /// - parameters:
- /// - interval: A number of seconds to wait before sending a value.
- /// - scheduler: A scheduler to send values on.
- ///
- /// - returns: A producer that sends values that are sent from `self` at
- /// least `interval` seconds apart.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func debounce(interval: NSTimeInterval, onScheduler scheduler: DateSchedulerType) -> SignalProducer<Value, Error> {
- return lift { $0.debounce(interval, onScheduler: scheduler) }
- }
- /// Forward events from `self` until `interval`. Then if producer isn't
- /// completed yet, fails with `error` on `scheduler`.
- ///
- /// - note: If the interval is 0, the timeout will be scheduled immediately.
- /// The producer must complete synchronously (or on a faster
- /// scheduler) to avoid the timeout.
- ///
- /// - parameters:
- /// - error: Error to send with `Failed` event if `self` is not completed
- /// when `interval` passes.
- /// - interval: Number of seconds to wait for `self` to complete.
- /// - scheudler: A scheduler to deliver error on.
- ///
- /// - returns: A producer that sends events for at most `interval` seconds,
- /// then, if not `Completed` - sends `error` with `Failed` event
- /// on `scheduler`.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func timeoutWithError(error: Error, afterInterval interval: NSTimeInterval, onScheduler scheduler: DateSchedulerType) -> SignalProducer<Value, Error> {
- return lift { $0.timeoutWithError(error, afterInterval: interval, onScheduler: scheduler) }
- }
- }
- extension SignalProducerType where Value: OptionalType {
- /// Unwraps non-`nil` values and forwards them on the returned signal, `nil`
- /// values are dropped.
- ///
- /// - returns: A producer that sends only non-nil values.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func ignoreNil() -> SignalProducer<Value.Wrapped, Error> {
- return lift { $0.ignoreNil() }
- }
- }
- extension SignalProducerType where Value: EventType, Error == NoError {
- /// The inverse of materialize(), this will translate a producer of `Event`
- /// _values_ into a producer of those events themselves.
- ///
- /// - returns: A producer that sends values carried by `self` events.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func dematerialize() -> SignalProducer<Value.Value, Value.Error> {
- return lift { $0.dematerialize() }
- }
- }
- extension SignalProducerType where Error == NoError {
- /// Promote a producer that does not generate failures into one that can.
- ///
- /// - note: This does not actually cause failers to be generated for the
- /// given producer, but makes it easier to combine with other
- /// producers that may fail; for example, with operators like
- /// `combineLatestWith`, `zipWith`, `flatten`, etc.
- ///
- /// - parameters:
- /// - _ An `ErrorType`.
- ///
- /// - returns: A producer that has an instantiatable `ErrorType`.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func promoteErrors<F: ErrorType>(_: F.Type) -> SignalProducer<Value, F> {
- return lift { $0.promoteErrors(F) }
- }
- }
- extension SignalProducerType where Value: Equatable {
- /// Forward only those values from `self` which are not duplicates of the
- /// immedately preceding value.
- ///
- /// - note: The first value is always forwarded.
- ///
- /// - returns: A producer that does not send two equal values sequentially.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func skipRepeats() -> SignalProducer<Value, Error> {
- return lift { $0.skipRepeats() }
- }
- }
- extension SignalProducerType {
- /// Forward only those values from `self` that have unique identities across
- /// the set of all values that have been seen.
- ///
- /// - note: This causes the identities to be retained to check for
- /// uniqueness.
- ///
- /// - parameters:
- /// - transform: A closure that accepts a value and returns identity
- /// value.
- ///
- /// - returns: A producer that sends unique values during its lifetime.
- @warn_unused_result(message="Did you forget to call `observe` on the signal?")
- public func uniqueValues<Identity: Hashable>(transform: Value -> Identity) -> SignalProducer<Value, Error> {
- return lift { $0.uniqueValues(transform) }
- }
- }
- extension SignalProducerType where Value: Hashable {
- /// Forward only those values from `self` that are unique across the set of
- /// all values that have been seen.
- ///
- /// - note: This causes the values to be retained to check for uniqueness.
- /// Providing a function that returns a unique value for each sent
- /// value can help you reduce the memory footprint.
- ///
- /// - returns: A producer that sends unique values during its lifetime.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func uniqueValues() -> SignalProducer<Value, Error> {
- return lift { $0.uniqueValues() }
- }
- }
- /// Create a repeating timer of the given interval, with a reasonable default
- /// leeway, sending updates on the given scheduler.
- ///
- /// - note: This timer will never complete naturally, so all invocations of
- /// `start()` must be disposed to avoid leaks.
- ///
- /// - precondition: Interval must be non-negative number.
- ///
- /// - parameters:
- /// - interval: An interval between invocations.
- /// - scheduler: A scheduler to deliver events on.
- ///
- /// - returns: A producer that sends `NSDate` values every `interval` seconds.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func timer(interval: NSTimeInterval, onScheduler scheduler: DateSchedulerType) -> SignalProducer<NSDate, NoError> {
- // Apple's "Power Efficiency Guide for Mac Apps" recommends a leeway of
- // at least 10% of the timer interval.
- return timer(interval, onScheduler: scheduler, withLeeway: interval * 0.1)
- }
- /// Creates a repeating timer of the given interval, sending updates on the
- /// given scheduler.
- ///
- /// - note: This timer will never complete naturally, so all invocations of
- /// `start()` must be disposed to avoid leaks.
- ///
- /// - precondition: Interval must be non-negative number.
- ///
- /// - precondition: Leeway must be non-negative number.
- ///
- /// - parameters:
- /// - interval: An interval between invocations.
- /// - scheduler: A scheduler to deliver events on.
- /// - leeway: Interval leeway. Apple's "Power Efficiency Guide for Mac Apps"
- /// recommends a leeway of at least 10% of the timer interval.
- ///
- /// - returns: A producer that sends `NSDate` values every `interval` seconds.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func timer(interval: NSTimeInterval, onScheduler scheduler: DateSchedulerType, withLeeway leeway: NSTimeInterval) -> SignalProducer<NSDate, NoError> {
- precondition(interval >= 0)
- precondition(leeway >= 0)
- return SignalProducer { observer, compositeDisposable in
- compositeDisposable += scheduler.scheduleAfter(scheduler.currentDate.dateByAddingTimeInterval(interval), repeatingEvery: interval, withLeeway: leeway) {
- observer.sendNext(scheduler.currentDate)
- }
- }
- }
- extension SignalProducerType {
- /// Injects side effects to be performed upon the specified producer events.
- ///
- /// - parameters:
- /// - started: A closrure that is invoked when producer is started.
- /// - event: A closure that accepts an event and is invoked on every
- /// received event.
- /// - failed: A closure that accepts error object and is invoked for
- /// `Failed` event.
- /// - completed: A closure that is invoked for `Completed` event.
- /// - interrupted: A closure that is invoked for `Interrupted` event.
- /// - terminated: A closure that is invoked for any terminating event.
- /// - disposed: A closure added as disposable when signal completes.
- /// - next: A closure that accepts a value from `Next` event.
- ///
- /// - returns: A producer with attached side-effects for given event cases.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func on(started started: (() -> Void)? = nil, event: (Event<Value, Error> -> Void)? = nil, failed: (Error -> Void)? = nil, completed: (() -> Void)? = nil, interrupted: (() -> Void)? = nil, terminated: (() -> Void)? = nil, disposed: (() -> Void)? = nil, next: (Value -> Void)? = nil) -> SignalProducer<Value, Error> {
- return SignalProducer { observer, compositeDisposable in
- started?()
- self.startWithSignal { signal, disposable in
- compositeDisposable += disposable
- compositeDisposable += signal
- .on(
- event: event,
- failed: failed,
- completed: completed,
- interrupted: interrupted,
- terminated: terminated,
- disposed: disposed,
- next: next
- )
- .observe(observer)
- }
- }
- }
- /// Start the returned producer on the given `Scheduler`.
- ///
- /// - note: This implies that any side effects embedded in the producer will
- /// be performed on the given scheduler as well.
- ///
- /// - note: Events may still be sent upon other schedulers — this merely
- /// affects where the `start()` method is run.
- ///
- /// - parameters:
- /// - scheduler: A scheduler to deliver events on.
- ///
- /// - returns: A producer that will deliver events on given `scheduler` when
- /// started.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func startOn(scheduler: SchedulerType) -> SignalProducer<Value, Error> {
- return SignalProducer { observer, compositeDisposable in
- compositeDisposable += scheduler.schedule {
- self.startWithSignal { signal, signalDisposable in
- compositeDisposable.addDisposable(signalDisposable)
- signal.observe(observer)
- }
- }
- }
- }
- }
- /// Combines the values of all the given producers, in the manner described by
- /// `combineLatestWith`.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func combineLatest<A, B, Error>(a: SignalProducer<A, Error>, _ b: SignalProducer<B, Error>) -> SignalProducer<(A, B), Error> {
- return a.combineLatestWith(b)
- }
- /// Combines the values of all the given producers, in the manner described by
- /// `combineLatestWith`.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func combineLatest<A, B, C, Error>(a: SignalProducer<A, Error>, _ b: SignalProducer<B, Error>, _ c: SignalProducer<C, Error>) -> SignalProducer<(A, B, C), Error> {
- return combineLatest(a, b)
- .combineLatestWith(c)
- .map(repack)
- }
- /// Combines the values of all the given producers, in the manner described by
- /// `combineLatestWith`.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func combineLatest<A, B, C, D, Error>(a: SignalProducer<A, Error>, _ b: SignalProducer<B, Error>, _ c: SignalProducer<C, Error>, _ d: SignalProducer<D, Error>) -> SignalProducer<(A, B, C, D), Error> {
- return combineLatest(a, b, c)
- .combineLatestWith(d)
- .map(repack)
- }
- /// Combines the values of all the given producers, in the manner described by
- /// `combineLatestWith`.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func combineLatest<A, B, C, D, E, Error>(a: SignalProducer<A, Error>, _ b: SignalProducer<B, Error>, _ c: SignalProducer<C, Error>, _ d: SignalProducer<D, Error>, _ e: SignalProducer<E, Error>) -> SignalProducer<(A, B, C, D, E), Error> {
- return combineLatest(a, b, c, d)
- .combineLatestWith(e)
- .map(repack)
- }
- /// Combines the values of all the given producers, in the manner described by
- /// `combineLatestWith`.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func combineLatest<A, B, C, D, E, F, Error>(a: SignalProducer<A, Error>, _ b: SignalProducer<B, Error>, _ c: SignalProducer<C, Error>, _ d: SignalProducer<D, Error>, _ e: SignalProducer<E, Error>, _ f: SignalProducer<F, Error>) -> SignalProducer<(A, B, C, D, E, F), Error> {
- return combineLatest(a, b, c, d, e)
- .combineLatestWith(f)
- .map(repack)
- }
- /// Combines the values of all the given producers, in the manner described by
- /// `combineLatestWith`.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func combineLatest<A, B, C, D, E, F, G, Error>(a: SignalProducer<A, Error>, _ b: SignalProducer<B, Error>, _ c: SignalProducer<C, Error>, _ d: SignalProducer<D, Error>, _ e: SignalProducer<E, Error>, _ f: SignalProducer<F, Error>, _ g: SignalProducer<G, Error>) -> SignalProducer<(A, B, C, D, E, F, G), Error> {
- return combineLatest(a, b, c, d, e, f)
- .combineLatestWith(g)
- .map(repack)
- }
- /// Combines the values of all the given producers, in the manner described by
- /// `combineLatestWith`.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func combineLatest<A, B, C, D, E, F, G, H, Error>(a: SignalProducer<A, Error>, _ b: SignalProducer<B, Error>, _ c: SignalProducer<C, Error>, _ d: SignalProducer<D, Error>, _ e: SignalProducer<E, Error>, _ f: SignalProducer<F, Error>, _ g: SignalProducer<G, Error>, _ h: SignalProducer<H, Error>) -> SignalProducer<(A, B, C, D, E, F, G, H), Error> {
- return combineLatest(a, b, c, d, e, f, g)
- .combineLatestWith(h)
- .map(repack)
- }
- /// Combines the values of all the given producers, in the manner described by
- /// `combineLatestWith`.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func combineLatest<A, B, C, D, E, F, G, H, I, Error>(a: SignalProducer<A, Error>, _ b: SignalProducer<B, Error>, _ c: SignalProducer<C, Error>, _ d: SignalProducer<D, Error>, _ e: SignalProducer<E, Error>, _ f: SignalProducer<F, Error>, _ g: SignalProducer<G, Error>, _ h: SignalProducer<H, Error>, _ i: SignalProducer<I, Error>) -> SignalProducer<(A, B, C, D, E, F, G, H, I), Error> {
- return combineLatest(a, b, c, d, e, f, g, h)
- .combineLatestWith(i)
- .map(repack)
- }
- /// Combines the values of all the given producers, in the manner described by
- /// `combineLatestWith`.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func combineLatest<A, B, C, D, E, F, G, H, I, J, Error>(a: SignalProducer<A, Error>, _ b: SignalProducer<B, Error>, _ c: SignalProducer<C, Error>, _ d: SignalProducer<D, Error>, _ e: SignalProducer<E, Error>, _ f: SignalProducer<F, Error>, _ g: SignalProducer<G, Error>, _ h: SignalProducer<H, Error>, _ i: SignalProducer<I, Error>, _ j: SignalProducer<J, Error>) -> SignalProducer<(A, B, C, D, E, F, G, H, I, J), Error> {
- return combineLatest(a, b, c, d, e, f, g, h, i)
- .combineLatestWith(j)
- .map(repack)
- }
- /// Combines the values of all the given producers, in the manner described by
- /// `combineLatestWith`. Will return an empty `SignalProducer` if the sequence
- /// is empty.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func combineLatest<S: SequenceType, Value, Error where S.Generator.Element == SignalProducer<Value, Error>>(producers: S) -> SignalProducer<[Value], Error> {
- var generator = producers.generate()
- if let first = generator.next() {
- let initial = first.map { [$0] }
- return GeneratorSequence(generator).reduce(initial) { producer, next in
- producer.combineLatestWith(next).map { $0.0 + [$0.1] }
- }
- }
-
- return .empty
- }
- /// Zips the values of all the given producers, in the manner described by
- /// `zipWith`.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func zip<A, B, Error>(a: SignalProducer<A, Error>, _ b: SignalProducer<B, Error>) -> SignalProducer<(A, B), Error> {
- return a.zipWith(b)
- }
- /// Zips the values of all the given producers, in the manner described by
- /// `zipWith`.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func zip<A, B, C, Error>(a: SignalProducer<A, Error>, _ b: SignalProducer<B, Error>, _ c: SignalProducer<C, Error>) -> SignalProducer<(A, B, C), Error> {
- return zip(a, b)
- .zipWith(c)
- .map(repack)
- }
- /// Zips the values of all the given producers, in the manner described by
- /// `zipWith`.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func zip<A, B, C, D, Error>(a: SignalProducer<A, Error>, _ b: SignalProducer<B, Error>, _ c: SignalProducer<C, Error>, _ d: SignalProducer<D, Error>) -> SignalProducer<(A, B, C, D), Error> {
- return zip(a, b, c)
- .zipWith(d)
- .map(repack)
- }
- /// Zips the values of all the given producers, in the manner described by
- /// `zipWith`.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func zip<A, B, C, D, E, Error>(a: SignalProducer<A, Error>, _ b: SignalProducer<B, Error>, _ c: SignalProducer<C, Error>, _ d: SignalProducer<D, Error>, _ e: SignalProducer<E, Error>) -> SignalProducer<(A, B, C, D, E), Error> {
- return zip(a, b, c, d)
- .zipWith(e)
- .map(repack)
- }
- /// Zips the values of all the given producers, in the manner described by
- /// `zipWith`.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func zip<A, B, C, D, E, F, Error>(a: SignalProducer<A, Error>, _ b: SignalProducer<B, Error>, _ c: SignalProducer<C, Error>, _ d: SignalProducer<D, Error>, _ e: SignalProducer<E, Error>, _ f: SignalProducer<F, Error>) -> SignalProducer<(A, B, C, D, E, F), Error> {
- return zip(a, b, c, d, e)
- .zipWith(f)
- .map(repack)
- }
- /// Zips the values of all the given producers, in the manner described by
- /// `zipWith`.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func zip<A, B, C, D, E, F, G, Error>(a: SignalProducer<A, Error>, _ b: SignalProducer<B, Error>, _ c: SignalProducer<C, Error>, _ d: SignalProducer<D, Error>, _ e: SignalProducer<E, Error>, _ f: SignalProducer<F, Error>, _ g: SignalProducer<G, Error>) -> SignalProducer<(A, B, C, D, E, F, G), Error> {
- return zip(a, b, c, d, e, f)
- .zipWith(g)
- .map(repack)
- }
- /// Zips the values of all the given producers, in the manner described by
- /// `zipWith`.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func zip<A, B, C, D, E, F, G, H, Error>(a: SignalProducer<A, Error>, _ b: SignalProducer<B, Error>, _ c: SignalProducer<C, Error>, _ d: SignalProducer<D, Error>, _ e: SignalProducer<E, Error>, _ f: SignalProducer<F, Error>, _ g: SignalProducer<G, Error>, _ h: SignalProducer<H, Error>) -> SignalProducer<(A, B, C, D, E, F, G, H), Error> {
- return zip(a, b, c, d, e, f, g)
- .zipWith(h)
- .map(repack)
- }
- /// Zips the values of all the given producers, in the manner described by
- /// `zipWith`.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func zip<A, B, C, D, E, F, G, H, I, Error>(a: SignalProducer<A, Error>, _ b: SignalProducer<B, Error>, _ c: SignalProducer<C, Error>, _ d: SignalProducer<D, Error>, _ e: SignalProducer<E, Error>, _ f: SignalProducer<F, Error>, _ g: SignalProducer<G, Error>, _ h: SignalProducer<H, Error>, _ i: SignalProducer<I, Error>) -> SignalProducer<(A, B, C, D, E, F, G, H, I), Error> {
- return zip(a, b, c, d, e, f, g, h)
- .zipWith(i)
- .map(repack)
- }
- /// Zips the values of all the given producers, in the manner described by
- /// `zipWith`.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func zip<A, B, C, D, E, F, G, H, I, J, Error>(a: SignalProducer<A, Error>, _ b: SignalProducer<B, Error>, _ c: SignalProducer<C, Error>, _ d: SignalProducer<D, Error>, _ e: SignalProducer<E, Error>, _ f: SignalProducer<F, Error>, _ g: SignalProducer<G, Error>, _ h: SignalProducer<H, Error>, _ i: SignalProducer<I, Error>, _ j: SignalProducer<J, Error>) -> SignalProducer<(A, B, C, D, E, F, G, H, I, J), Error> {
- return zip(a, b, c, d, e, f, g, h, i)
- .zipWith(j)
- .map(repack)
- }
- /// Zips the values of all the given producers, in the manner described by
- /// `zipWith`. Will return an empty `SignalProducer` if the sequence is empty.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func zip<S: SequenceType, Value, Error where S.Generator.Element == SignalProducer<Value, Error>>(producers: S) -> SignalProducer<[Value], Error> {
- var generator = producers.generate()
- if let first = generator.next() {
- let initial = first.map { [$0] }
- return GeneratorSequence(generator).reduce(initial) { producer, next in
- producer.zipWith(next).map { $0.0 + [$0.1] }
- }
- }
- return .empty
- }
- extension SignalProducerType {
- /// Repeat `self` a total of `count` times. In other words, start producer
- /// `count` number of times, each one after previously started producer
- /// completes.
- ///
- /// - note: Repeating `1` time results in an equivalent signal producer.
- ///
- /// - note: Repeating `0` times results in a producer that instantly
- /// completes.
- ///
- /// - parameters:
- /// - count: Number of repetitions.
- ///
- /// - returns: A signal producer start sequentially starts `self` after
- /// previously started producer completes.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func times(count: Int) -> SignalProducer<Value, Error> {
- precondition(count >= 0)
- if count == 0 {
- return .empty
- } else if count == 1 {
- return producer
- }
- return SignalProducer { observer, disposable in
- let serialDisposable = SerialDisposable()
- disposable.addDisposable(serialDisposable)
- func iterate(current: Int) {
- self.startWithSignal { signal, signalDisposable in
- serialDisposable.innerDisposable = signalDisposable
- signal.observe { event in
- if case .Completed = event {
- let remainingTimes = current - 1
- if remainingTimes > 0 {
- iterate(remainingTimes)
- } else {
- observer.sendCompleted()
- }
- } else {
- observer.action(event)
- }
- }
- }
- }
- iterate(count)
- }
- }
- /// Ignore failures up to `count` times.
- ///
- /// - precondition: `count` must be non-negative integer.
- ///
- /// - parameters:
- /// - count: Number of retries.
- ///
- /// - returns: A signal producer that restarts up to `count` times.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func retry(count: Int) -> SignalProducer<Value, Error> {
- precondition(count >= 0)
- if count == 0 {
- return producer
- } else {
- return flatMapError { _ in
- self.retry(count - 1)
- }
- }
- }
- /// Wait for completion of `self`, *then* forward all events from
- /// `replacement`. Any failure or interruption sent from `self` is
- /// forwarded immediately, in which case `replacement` will not be started,
- /// and none of its events will be be forwarded.
- ///
- /// - note: All values sent from `self` are ignored.
- ///
- /// - parameters:
- /// - replacement: A producer to start when `self` completes.
- ///
- /// - returns: A producer that sends events from `self` and then from
- /// `replacement` when `self` completes.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func then<U>(replacement: SignalProducer<U, Error>) -> SignalProducer<U, Error> {
- return SignalProducer<U, Error> { observer, observerDisposable in
- self.startWithSignal { signal, signalDisposable in
- observerDisposable.addDisposable(signalDisposable)
- signal.observe { event in
- switch event {
- case let .Failed(error):
- observer.sendFailed(error)
- case .Completed:
- observerDisposable += replacement.start(observer)
- case .Interrupted:
- observer.sendInterrupted()
- case .Next:
- break
- }
- }
- }
- }
- }
- /// Start the producer, then block, waiting for the first value.
- ///
- /// When a single value or error is sent, the returned `Result` will
- /// represent those cases. However, when no values are sent, `nil` will be
- /// returned.
- ///
- /// - returns: Result when single `Next` or `Failed` event is received.
- /// `nil` when no events are received.
- @warn_unused_result(message="Did you forget to check the result?")
- public func first() -> Result<Value, Error>? {
- return take(1).single()
- }
- /// Start the producer, then block, waiting for events: Next and
- /// Completed.
- ///
- /// When a single value or error is sent, the returned `Result` will
- /// represent those cases. However, when no values are sent, or when more
- /// than one value is sent, `nil` will be returned.
- ///
- /// - returns: Result when single `Next` or `Failed` event is received.
- /// `nil` when 0 or more than 1 events are received.
- @warn_unused_result(message="Did you forget to check the result?")
- public func single() -> Result<Value, Error>? {
- let semaphore = dispatch_semaphore_create(0)
- var result: Result<Value, Error>?
- take(2).start { event in
- switch event {
- case let .Next(value):
- if result != nil {
- // Move into failure state after recieving another value.
- result = nil
- return
- }
- result = .Success(value)
- case let .Failed(error):
- result = .Failure(error)
- dispatch_semaphore_signal(semaphore)
- case .Completed, .Interrupted:
- dispatch_semaphore_signal(semaphore)
- }
- }
-
- dispatch_semaphore_wait(semaphore, DISPATCH_TIME_FOREVER)
- return result
- }
- /// Start the producer, then block, waiting for the last value.
- ///
- /// When a single value or error is sent, the returned `Result` will
- /// represent those cases. However, when no values are sent, `nil` will be
- /// returned.
- ///
- /// - returns: Result when single `Next` or `Failed` event is received.
- /// `nil` when no events are received.
- @warn_unused_result(message="Did you forget to check the result?")
- public func last() -> Result<Value, Error>? {
- return takeLast(1).single()
- }
- /// Starts the producer, then blocks, waiting for completion.
- ///
- /// When a completion or error is sent, the returned `Result` will represent
- /// those cases.
- ///
- /// - returns: Result when single `Completion` or `Failed` event is
- /// received.
- @warn_unused_result(message="Did you forget to check the result?")
- public func wait() -> Result<(), Error> {
- return then(SignalProducer<(), Error>(value: ())).last() ?? .Success(())
- }
- /// Creates a new `SignalProducer` that will multicast values emitted by
- /// the underlying producer, up to `capacity`.
- /// This means that all clients of this `SignalProducer` will see the same
- /// version of the emitted values/errors.
- ///
- /// The underlying `SignalProducer` will not be started until `self` is
- /// started for the first time. When subscribing to this producer, all
- /// previous values (up to `capacity`) will be emitted, followed by any new
- /// values.
- ///
- /// If you find yourself needing *the current value* (the last buffered
- /// value) you should consider using `PropertyType` instead, which, unlike
- /// this operator, will guarantee at compile time that there's always a
- /// buffered value. This operator is not recommended in most cases, as it
- /// will introduce an implicit relationship between the original client and
- /// the rest, so consider alternatives like `PropertyType`, or representing
- /// your stream using a `Signal` instead.
- ///
- /// This operator is only recommended when you absolutely need to introduce
- /// a layer of caching in front of another `SignalProducer`.
- ///
- /// - note: This operator has the same semantics as `SignalProducer.buffer`.
- ///
- /// - precondtion: `capacity` must be non-negative integer.
- ///
- /// - parameters:
- /// - capcity: Number of values to hold.
- ///
- /// - returns: A caching producer that will hold up to last `capacity`
- /// values.
- @warn_unused_result(message="Did you forget to call `start` on the producer?")
- public func replayLazily(capacity: Int) -> SignalProducer<Value, Error> {
- precondition(capacity >= 0, "Invalid capacity: \(capacity)")
- var producer: SignalProducer<Value, Error>?
- var producerObserver: SignalProducer<Value, Error>.ProducedSignal.Observer?
- let lock = NSLock()
- lock.name = "org.reactivecocoa.ReactiveCocoa.SignalProducer.replayLazily"
- // This will go "out of scope" when the returned `SignalProducer` goes
- // out of scope. This lets us know when we're supposed to dispose the
- // underlying producer. This is necessary because `struct`s don't have
- // `deinit`.
- let token = DeallocationToken()
- return SignalProducer { observer, disposable in
- var token: DeallocationToken? = token
- let initializedProducer: SignalProducer<Value, Error>
- let initializedObserver: SignalProducer<Value, Error>.ProducedSignal.Observer
- let shouldStartUnderlyingProducer: Bool
- lock.lock()
- if let producer = producer, producerObserver = producerObserver {
- (initializedProducer, initializedObserver) = (producer, producerObserver)
- shouldStartUnderlyingProducer = false
- } else {
- let (producerTemp, observerTemp) = SignalProducer<Value, Error>.buffer(capacity)
- (producer, producerObserver) = (producerTemp, observerTemp)
- (initializedProducer, initializedObserver) = (producerTemp, observerTemp)
- shouldStartUnderlyingProducer = true
- }
- lock.unlock()
- // subscribe `observer` before starting the underlying producer.
- disposable += initializedProducer.start(observer)
- disposable += {
- // Don't dispose of the original producer until all observers
- // have terminated.
- token = nil
- }
- if shouldStartUnderlyingProducer {
- self.takeUntil(token!.deallocSignal)
- .start(initializedObserver)
- }
- }
- }
- }
- private final class DeallocationToken {
- let (deallocSignal, observer) = Signal<(), NoError>.pipe()
- deinit {
- observer.sendCompleted()
- }
- }
|