rx.lua 63 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252
  1. -- RxLua v0.0.3
  2. -- https://github.com/bjornbytes/rxlua
  3. -- MIT License
  4. local util = {}
  5. util.pack = table.pack or function(...) return { n = select('#', ...), ... } end
  6. util.unpack = table.unpack or unpack
  7. util.eq = function(x, y) return x == y end
  8. util.noop = function() end
  9. util.identity = function(x) return x end
  10. util.constant = function(x) return function() return x end end
  11. util.isa = function(object, class)
  12. return type(object) == 'table' and getmetatable(object).__index == class
  13. end
  14. util.tryWithObserver = function(observer, fn, ...)
  15. local success, result = pcall(fn, ...)
  16. if not success then
  17. observer:onError(result)
  18. end
  19. return success, result
  20. end
  21. --- @class Subscription
  22. -- @description A handle representing the link between an Observer and an Observable, as well as any
  23. -- work required to clean up after the Observable completes or the Observer unsubscribes.
  24. local Subscription = {}
  25. Subscription.__index = Subscription
  26. Subscription.__tostring = util.constant('Subscription')
  27. --- Creates a new Subscription.
  28. -- @arg {function=} action - The action to run when the subscription is unsubscribed. It will only
  29. -- be run once.
  30. -- @returns {Subscription}
  31. function Subscription.create(action)
  32. local self = {
  33. action = action or util.noop,
  34. unsubscribed = false
  35. }
  36. return setmetatable(self, Subscription)
  37. end
  38. --- Unsubscribes the subscription, performing any necessary cleanup work.
  39. function Subscription:unsubscribe()
  40. if self.unsubscribed then return end
  41. self.action(self)
  42. self.unsubscribed = true
  43. end
  44. --- @class Observer
  45. -- @description Observers are simple objects that receive values from Observables.
  46. local Observer = {}
  47. Observer.__index = Observer
  48. Observer.__tostring = util.constant('Observer')
  49. --- Creates a new Observer.
  50. -- @arg {function=} onNext - Called when the Observable produces a value.
  51. -- @arg {function=} onError - Called when the Observable terminates due to an error.
  52. -- @arg {function=} onCompleted - Called when the Observable completes normally.
  53. -- @returns {Observer}
  54. function Observer.create(onNext, onError, onCompleted)
  55. local self = {
  56. _onNext = onNext or util.noop,
  57. _onError = onError or error,
  58. _onCompleted = onCompleted or util.noop,
  59. stopped = false
  60. }
  61. return setmetatable(self, Observer)
  62. end
  63. --- Pushes zero or more values to the Observer.
  64. -- @arg {*...} values
  65. function Observer:onNext(...)
  66. if not self.stopped then
  67. self._onNext(...)
  68. end
  69. end
  70. --- Notify the Observer that an error has occurred.
  71. -- @arg {string=} message - A string describing what went wrong.
  72. function Observer:onError(message)
  73. if not self.stopped then
  74. self.stopped = true
  75. self._onError(message)
  76. end
  77. end
  78. --- Notify the Observer that the sequence has completed and will produce no more values.
  79. function Observer:onCompleted()
  80. if not self.stopped then
  81. self.stopped = true
  82. self._onCompleted()
  83. end
  84. end
  85. --- @class Observable
  86. -- @description Observables push values to Observers.
  87. local Observable = {}
  88. Observable.__index = Observable
  89. Observable.__tostring = util.constant('Observable')
  90. --- Creates a new Observable.
  91. -- @arg {function} subscribe - The subscription function that produces values.
  92. -- @returns {Observable}
  93. function Observable.create(subscribe)
  94. local self = {
  95. _subscribe = subscribe
  96. }
  97. return setmetatable(self, Observable)
  98. end
  99. --- Shorthand for creating an Observer and passing it to this Observable's subscription function.
  100. -- @arg {function} onNext - Called when the Observable produces a value.
  101. -- @arg {function} onError - Called when the Observable terminates due to an error.
  102. -- @arg {function} onCompleted - Called when the Observable completes normally.
  103. function Observable:subscribe(onNext, onError, onCompleted)
  104. if type(onNext) == 'table' then
  105. return self._subscribe(onNext)
  106. else
  107. return self._subscribe(Observer.create(onNext, onError, onCompleted))
  108. end
  109. end
  110. --- Returns an Observable that immediately completes without producing a value.
  111. function Observable.empty()
  112. return Observable.create(function(observer)
  113. observer:onCompleted()
  114. end)
  115. end
  116. --- Returns an Observable that never produces values and never completes.
  117. function Observable.never()
  118. return Observable.create(function(observer) end)
  119. end
  120. --- Returns an Observable that immediately produces an error.
  121. function Observable.throw(message)
  122. return Observable.create(function(observer)
  123. observer:onError(message)
  124. end)
  125. end
  126. --- Creates an Observable that produces a set of values.
  127. -- @arg {*...} values
  128. -- @returns {Observable}
  129. function Observable.of(...)
  130. local args = {...}
  131. local argCount = select('#', ...)
  132. return Observable.create(function(observer)
  133. for i = 1, argCount do
  134. observer:onNext(args[i])
  135. end
  136. observer:onCompleted()
  137. end)
  138. end
  139. --- Creates an Observable that produces a range of values in a manner similar to a Lua for loop.
  140. -- @arg {number} initial - The first value of the range, or the upper limit if no other arguments
  141. -- are specified.
  142. -- @arg {number=} limit - The second value of the range.
  143. -- @arg {number=1} step - An amount to increment the value by each iteration.
  144. -- @returns {Observable}
  145. function Observable.fromRange(initial, limit, step)
  146. if not limit and not step then
  147. initial, limit = 1, initial
  148. end
  149. step = step or 1
  150. return Observable.create(function(observer)
  151. for i = initial, limit, step do
  152. observer:onNext(i)
  153. end
  154. observer:onCompleted()
  155. end)
  156. end
  157. --- Creates an Observable that produces values from a table.
  158. -- @arg {table} table - The table used to create the Observable.
  159. -- @arg {function=pairs} iterator - An iterator used to iterate the table, e.g. pairs or ipairs.
  160. -- @arg {boolean} keys - Whether or not to also emit the keys of the table.
  161. -- @returns {Observable}
  162. function Observable.fromTable(t, iterator, keys)
  163. iterator = iterator or pairs
  164. return Observable.create(function(observer)
  165. for key, value in iterator(t) do
  166. observer:onNext(value, keys and key or nil)
  167. end
  168. observer:onCompleted()
  169. end)
  170. end
  171. --- Creates an Observable that produces values when the specified coroutine yields.
  172. -- @arg {thread|function} fn - A coroutine or function to use to generate values. Note that if a
  173. -- coroutine is used, the values it yields will be shared by all
  174. -- subscribed Observers (influenced by the Scheduler), whereas a new
  175. -- coroutine will be created for each Observer when a function is used.
  176. -- @returns {Observable}
  177. function Observable.fromCoroutine(fn, scheduler)
  178. return Observable.create(function(observer)
  179. local thread = type(fn) == 'function' and coroutine.create(fn) or fn
  180. return scheduler:schedule(function()
  181. while not observer.stopped do
  182. local success, value = coroutine.resume(thread)
  183. if success then
  184. observer:onNext(value)
  185. else
  186. return observer:onError(value)
  187. end
  188. if coroutine.status(thread) == 'dead' then
  189. return observer:onCompleted()
  190. end
  191. coroutine.yield()
  192. end
  193. end)
  194. end)
  195. end
  196. --- Creates an Observable that produces values from a file, line by line.
  197. -- @arg {string} filename - The name of the file used to create the Observable
  198. -- @returns {Observable}
  199. function Observable.fromFileByLine(filename)
  200. return Observable.create(function(observer)
  201. local f = io.open(filename, 'r')
  202. if f
  203. then
  204. f:close()
  205. for line in io.lines(filename) do
  206. observer:onNext(line)
  207. end
  208. return observer:onCompleted()
  209. else
  210. return observer:onError(filename)
  211. end
  212. end)
  213. end
  214. --- Creates an Observable that creates a new Observable for each observer using a factory function.
  215. -- @arg {function} factory - A function that returns an Observable.
  216. -- @returns {Observable}
  217. function Observable.defer(fn)
  218. return setmetatable({
  219. subscribe = function(_, ...)
  220. local observable = fn()
  221. return observable:subscribe(...)
  222. end
  223. }, Observable)
  224. end
  225. --- Returns an Observable that repeats a value a specified number of times.
  226. -- @arg {*} value - The value to repeat.
  227. -- @arg {number=} count - The number of times to repeat the value. If left unspecified, the value
  228. -- is repeated an infinite number of times.
  229. -- @returns {Observable}
  230. function Observable.replicate(value, count)
  231. return Observable.create(function(observer)
  232. while count == nil or count > 0 do
  233. observer:onNext(value)
  234. if count then
  235. count = count - 1
  236. end
  237. end
  238. observer:onCompleted()
  239. end)
  240. end
  241. --- Subscribes to this Observable and prints values it produces.
  242. -- @arg {string=} name - Prefixes the printed messages with a name.
  243. -- @arg {function=tostring} formatter - A function that formats one or more values to be printed.
  244. function Observable:dump(name, formatter)
  245. name = name and (name .. ' ') or ''
  246. formatter = formatter or tostring
  247. local onNext = function(...) print(name .. 'onNext: ' .. formatter(...)) end
  248. local onError = function(e) print(name .. 'onError: ' .. e) end
  249. local onCompleted = function() print(name .. 'onCompleted') end
  250. return self:subscribe(onNext, onError, onCompleted)
  251. end
  252. --- Determine whether all items emitted by an Observable meet some criteria.
  253. -- @arg {function=identity} predicate - The predicate used to evaluate objects.
  254. function Observable:all(predicate)
  255. predicate = predicate or util.identity
  256. return Observable.create(function(observer)
  257. local function onNext(...)
  258. util.tryWithObserver(observer, function(...)
  259. if not predicate(...) then
  260. observer:onNext(false)
  261. observer:onCompleted()
  262. end
  263. end, ...)
  264. end
  265. local function onError(e)
  266. return observer:onError(e)
  267. end
  268. local function onCompleted()
  269. observer:onNext(true)
  270. return observer:onCompleted()
  271. end
  272. return self:subscribe(onNext, onError, onCompleted)
  273. end)
  274. end
  275. --- Given a set of Observables, produces values from only the first one to produce a value.
  276. -- @arg {Observable...} observables
  277. -- @returns {Observable}
  278. function Observable.amb(a, b, ...)
  279. if not a or not b then return a end
  280. return Observable.create(function(observer)
  281. local subscriptionA, subscriptionB
  282. local function onNextA(...)
  283. if subscriptionB then subscriptionB:unsubscribe() end
  284. observer:onNext(...)
  285. end
  286. local function onErrorA(e)
  287. if subscriptionB then subscriptionB:unsubscribe() end
  288. observer:onError(e)
  289. end
  290. local function onCompletedA()
  291. if subscriptionB then subscriptionB:unsubscribe() end
  292. observer:onCompleted()
  293. end
  294. local function onNextB(...)
  295. if subscriptionA then subscriptionA:unsubscribe() end
  296. observer:onNext(...)
  297. end
  298. local function onErrorB(e)
  299. if subscriptionA then subscriptionA:unsubscribe() end
  300. observer:onError(e)
  301. end
  302. local function onCompletedB()
  303. if subscriptionA then subscriptionA:unsubscribe() end
  304. observer:onCompleted()
  305. end
  306. subscriptionA = a:subscribe(onNextA, onErrorA, onCompletedA)
  307. subscriptionB = b:subscribe(onNextB, onErrorB, onCompletedB)
  308. return Subscription.create(function()
  309. subscriptionA:unsubscribe()
  310. subscriptionB:unsubscribe()
  311. end)
  312. end):amb(...)
  313. end
  314. --- Returns an Observable that produces the average of all values produced by the original.
  315. -- @returns {Observable}
  316. function Observable:average()
  317. return Observable.create(function(observer)
  318. local sum, count = 0, 0
  319. local function onNext(value)
  320. sum = sum + value
  321. count = count + 1
  322. end
  323. local function onError(e)
  324. observer:onError(e)
  325. end
  326. local function onCompleted()
  327. if count > 0 then
  328. observer:onNext(sum / count)
  329. end
  330. observer:onCompleted()
  331. end
  332. return self:subscribe(onNext, onError, onCompleted)
  333. end)
  334. end
  335. --- Returns an Observable that buffers values from the original and produces them as multiple
  336. -- values.
  337. -- @arg {number} size - The size of the buffer.
  338. function Observable:buffer(size)
  339. return Observable.create(function(observer)
  340. local buffer = {}
  341. local function emit()
  342. if #buffer > 0 then
  343. observer:onNext(util.unpack(buffer))
  344. buffer = {}
  345. end
  346. end
  347. local function onNext(...)
  348. local values = {...}
  349. for i = 1, #values do
  350. table.insert(buffer, values[i])
  351. if #buffer >= size then
  352. emit()
  353. end
  354. end
  355. end
  356. local function onError(message)
  357. emit()
  358. return observer:onError(message)
  359. end
  360. local function onCompleted()
  361. emit()
  362. return observer:onCompleted()
  363. end
  364. return self:subscribe(onNext, onError, onCompleted)
  365. end)
  366. end
  367. --- Returns an Observable that intercepts any errors from the previous and replace them with values
  368. -- produced by a new Observable.
  369. -- @arg {function|Observable} handler - An Observable or a function that returns an Observable to
  370. -- replace the source Observable in the event of an error.
  371. -- @returns {Observable}
  372. function Observable:catch(handler)
  373. handler = handler and (type(handler) == 'function' and handler or util.constant(handler))
  374. return Observable.create(function(observer)
  375. local subscription
  376. local function onNext(...)
  377. return observer:onNext(...)
  378. end
  379. local function onError(e)
  380. if not handler then
  381. return observer:onCompleted()
  382. end
  383. local success, continue = pcall(handler, e)
  384. if success and continue then
  385. if subscription then subscription:unsubscribe() end
  386. continue:subscribe(observer)
  387. else
  388. observer:onError(success and e or continue)
  389. end
  390. end
  391. local function onCompleted()
  392. observer:onCompleted()
  393. end
  394. subscription = self:subscribe(onNext, onError, onCompleted)
  395. return subscription
  396. end)
  397. end
  398. --- Returns a new Observable that runs a combinator function on the most recent values from a set
  399. -- of Observables whenever any of them produce a new value. The results of the combinator function
  400. -- are produced by the new Observable.
  401. -- @arg {Observable...} observables - One or more Observables to combine.
  402. -- @arg {function} combinator - A function that combines the latest result from each Observable and
  403. -- returns a single value.
  404. -- @returns {Observable}
  405. function Observable:combineLatest(...)
  406. local sources = {...}
  407. local combinator = table.remove(sources)
  408. if type(combinator) ~= 'function' then
  409. table.insert(sources, combinator)
  410. combinator = function(...) return ... end
  411. end
  412. table.insert(sources, 1, self)
  413. return Observable.create(function(observer)
  414. local latest = {}
  415. local pending = {util.unpack(sources)}
  416. local completed = {}
  417. local subscription = {}
  418. local function onNext(i)
  419. return function(value)
  420. latest[i] = value
  421. pending[i] = nil
  422. if not next(pending) then
  423. util.tryWithObserver(observer, function()
  424. observer:onNext(combinator(util.unpack(latest)))
  425. end)
  426. end
  427. end
  428. end
  429. local function onError(e)
  430. return observer:onError(e)
  431. end
  432. local function onCompleted(i)
  433. return function()
  434. table.insert(completed, i)
  435. if #completed == #sources then
  436. observer:onCompleted()
  437. end
  438. end
  439. end
  440. for i = 1, #sources do
  441. subscription[i] = sources[i]:subscribe(onNext(i), onError, onCompleted(i))
  442. end
  443. return Subscription.create(function ()
  444. for i = 1, #sources do
  445. if subscription[i] then subscription[i]:unsubscribe() end
  446. end
  447. end)
  448. end)
  449. end
  450. --- Returns a new Observable that produces the values of the first with falsy values removed.
  451. -- @returns {Observable}
  452. function Observable:compact()
  453. return self:filter(util.identity)
  454. end
  455. --- Returns a new Observable that produces the values produced by all the specified Observables in
  456. -- the order they are specified.
  457. -- @arg {Observable...} sources - The Observables to concatenate.
  458. -- @returns {Observable}
  459. function Observable:concat(other, ...)
  460. if not other then return self end
  461. local others = {...}
  462. return Observable.create(function(observer)
  463. local function onNext(...)
  464. return observer:onNext(...)
  465. end
  466. local function onError(message)
  467. return observer:onError(message)
  468. end
  469. local function onCompleted()
  470. return observer:onCompleted()
  471. end
  472. local function chain()
  473. return other:concat(util.unpack(others)):subscribe(onNext, onError, onCompleted)
  474. end
  475. return self:subscribe(onNext, onError, chain)
  476. end)
  477. end
  478. --- Returns a new Observable that produces a single boolean value representing whether or not the
  479. -- specified value was produced by the original.
  480. -- @arg {*} value - The value to search for. == is used for equality testing.
  481. -- @returns {Observable}
  482. function Observable:contains(value)
  483. return Observable.create(function(observer)
  484. local subscription
  485. local function onNext(...)
  486. local args = util.pack(...)
  487. if #args == 0 and value == nil then
  488. observer:onNext(true)
  489. if subscription then subscription:unsubscribe() end
  490. return observer:onCompleted()
  491. end
  492. for i = 1, #args do
  493. if args[i] == value then
  494. observer:onNext(true)
  495. if subscription then subscription:unsubscribe() end
  496. return observer:onCompleted()
  497. end
  498. end
  499. end
  500. local function onError(e)
  501. return observer:onError(e)
  502. end
  503. local function onCompleted()
  504. observer:onNext(false)
  505. return observer:onCompleted()
  506. end
  507. subscription = self:subscribe(onNext, onError, onCompleted)
  508. return subscription
  509. end)
  510. end
  511. --- Returns an Observable that produces a single value representing the number of values produced
  512. -- by the source value that satisfy an optional predicate.
  513. -- @arg {function=} predicate - The predicate used to match values.
  514. function Observable:count(predicate)
  515. predicate = predicate or util.constant(true)
  516. return Observable.create(function(observer)
  517. local count = 0
  518. local function onNext(...)
  519. util.tryWithObserver(observer, function(...)
  520. if predicate(...) then
  521. count = count + 1
  522. end
  523. end, ...)
  524. end
  525. local function onError(e)
  526. return observer:onError(e)
  527. end
  528. local function onCompleted()
  529. observer:onNext(count)
  530. observer:onCompleted()
  531. end
  532. return self:subscribe(onNext, onError, onCompleted)
  533. end)
  534. end
  535. function Observable:debounce(time, scheduler)
  536. time = time or 0
  537. return Observable.create(function(observer)
  538. local debounced = {}
  539. local function wrap(key)
  540. return function(...)
  541. local value = util.pack(...)
  542. if debounced[key] then
  543. debounced[key]:unsubscribe()
  544. end
  545. local values = util.pack(...)
  546. debounced[key] = scheduler:schedule(function()
  547. return observer[key](observer, util.unpack(values))
  548. end, time)
  549. end
  550. end
  551. local subscription = self:subscribe(wrap('onNext'), wrap('onError'), wrap('onCompleted'))
  552. return Subscription.create(function()
  553. if subscription then subscription:unsubscribe() end
  554. for _, timeout in pairs(debounced) do
  555. timeout:unsubscribe()
  556. end
  557. end)
  558. end)
  559. end
  560. --- Returns a new Observable that produces a default set of items if the source Observable produces
  561. -- no values.
  562. -- @arg {*...} values - Zero or more values to produce if the source completes without emitting
  563. -- anything.
  564. -- @returns {Observable}
  565. function Observable:defaultIfEmpty(...)
  566. local defaults = util.pack(...)
  567. return Observable.create(function(observer)
  568. local hasValue = false
  569. local function onNext(...)
  570. hasValue = true
  571. observer:onNext(...)
  572. end
  573. local function onError(e)
  574. observer:onError(e)
  575. end
  576. local function onCompleted()
  577. if not hasValue then
  578. observer:onNext(util.unpack(defaults))
  579. end
  580. observer:onCompleted()
  581. end
  582. return self:subscribe(onNext, onError, onCompleted)
  583. end)
  584. end
  585. --- Returns a new Observable that produces the values of the original delayed by a time period.
  586. -- @arg {number|function} time - An amount in milliseconds to delay by, or a function which returns
  587. -- this value.
  588. -- @arg {Scheduler} scheduler - The scheduler to run the Observable on.
  589. -- @returns {Observable}
  590. function Observable:delay(time, scheduler)
  591. time = type(time) ~= 'function' and util.constant(time) or time
  592. return Observable.create(function(observer)
  593. local actions = {}
  594. local function delay(key)
  595. return function(...)
  596. local arg = util.pack(...)
  597. local handle = scheduler:schedule(function()
  598. observer[key](observer, util.unpack(arg))
  599. end, time())
  600. table.insert(actions, handle)
  601. end
  602. end
  603. local subscription = self:subscribe(delay('onNext'), delay('onError'), delay('onCompleted'))
  604. return Subscription.create(function()
  605. if subscription then subscription:unsubscribe() end
  606. for i = 1, #actions do
  607. actions[i]:unsubscribe()
  608. end
  609. end)
  610. end)
  611. end
  612. --- Returns a new Observable that produces the values from the original with duplicates removed.
  613. -- @returns {Observable}
  614. function Observable:distinct()
  615. return Observable.create(function(observer)
  616. local values = {}
  617. local function onNext(x)
  618. if not values[x] then
  619. observer:onNext(x)
  620. end
  621. values[x] = true
  622. end
  623. local function onError(e)
  624. return observer:onError(e)
  625. end
  626. local function onCompleted()
  627. return observer:onCompleted()
  628. end
  629. return self:subscribe(onNext, onError, onCompleted)
  630. end)
  631. end
  632. --- Returns an Observable that only produces values from the original if they are different from
  633. -- the previous value.
  634. -- @arg {function} comparator - A function used to compare 2 values. If unspecified, == is used.
  635. -- @returns {Observable}
  636. function Observable:distinctUntilChanged(comparator)
  637. comparator = comparator or util.eq
  638. return Observable.create(function(observer)
  639. local first = true
  640. local currentValue = nil
  641. local function onNext(value, ...)
  642. local values = util.pack(...)
  643. util.tryWithObserver(observer, function()
  644. if first or not comparator(value, currentValue) then
  645. observer:onNext(value, util.unpack(values))
  646. currentValue = value
  647. first = false
  648. end
  649. end)
  650. end
  651. local function onError(message)
  652. return observer:onError(message)
  653. end
  654. local function onCompleted()
  655. return observer:onCompleted()
  656. end
  657. return self:subscribe(onNext, onError, onCompleted)
  658. end)
  659. end
  660. --- Returns an Observable that produces the nth element produced by the source Observable.
  661. -- @arg {number} index - The index of the item, with an index of 1 representing the first.
  662. -- @returns {Observable}
  663. function Observable:elementAt(index)
  664. return Observable.create(function(observer)
  665. local subscription
  666. local i = 1
  667. local function onNext(...)
  668. if i == index then
  669. observer:onNext(...)
  670. observer:onCompleted()
  671. if subscription then
  672. subscription:unsubscribe()
  673. end
  674. else
  675. i = i + 1
  676. end
  677. end
  678. local function onError(e)
  679. return observer:onError(e)
  680. end
  681. local function onCompleted()
  682. return observer:onCompleted()
  683. end
  684. subscription = self:subscribe(onNext, onError, onCompleted)
  685. return subscription
  686. end)
  687. end
  688. --- Returns a new Observable that only produces values of the first that satisfy a predicate.
  689. -- @arg {function} predicate - The predicate used to filter values.
  690. -- @returns {Observable}
  691. function Observable:filter(predicate)
  692. predicate = predicate or util.identity
  693. return Observable.create(function(observer)
  694. local function onNext(...)
  695. util.tryWithObserver(observer, function(...)
  696. if predicate(...) then
  697. return observer:onNext(...)
  698. end
  699. end, ...)
  700. end
  701. local function onError(e)
  702. return observer:onError(e)
  703. end
  704. local function onCompleted()
  705. return observer:onCompleted()
  706. end
  707. return self:subscribe(onNext, onError, onCompleted)
  708. end)
  709. end
  710. --- Returns a new Observable that produces the first value of the original that satisfies a
  711. -- predicate.
  712. -- @arg {function} predicate - The predicate used to find a value.
  713. function Observable:find(predicate)
  714. predicate = predicate or util.identity
  715. return Observable.create(function(observer)
  716. local function onNext(...)
  717. util.tryWithObserver(observer, function(...)
  718. if predicate(...) then
  719. observer:onNext(...)
  720. return observer:onCompleted()
  721. end
  722. end, ...)
  723. end
  724. local function onError(message)
  725. return observer:onError(message)
  726. end
  727. local function onCompleted()
  728. return observer:onCompleted()
  729. end
  730. return self:subscribe(onNext, onError, onCompleted)
  731. end)
  732. end
  733. --- Returns a new Observable that only produces the first result of the original.
  734. -- @returns {Observable}
  735. function Observable:first()
  736. return self:take(1)
  737. end
  738. --- Returns a new Observable that transform the items emitted by an Observable into Observables,
  739. -- then flatten the emissions from those into a single Observable
  740. -- @arg {function} callback - The function to transform values from the original Observable.
  741. -- @returns {Observable}
  742. function Observable:flatMap(callback)
  743. callback = callback or util.identity
  744. return self:map(callback):flatten()
  745. end
  746. --- Returns a new Observable that uses a callback to create Observables from the values produced by
  747. -- the source, then produces values from the most recent of these Observables.
  748. -- @arg {function=identity} callback - The function used to convert values to Observables.
  749. -- @returns {Observable}
  750. function Observable:flatMapLatest(callback)
  751. callback = callback or util.identity
  752. return Observable.create(function(observer)
  753. local innerSubscription
  754. local function onNext(...)
  755. observer:onNext(...)
  756. end
  757. local function onError(e)
  758. return observer:onError(e)
  759. end
  760. local function onCompleted()
  761. return observer:onCompleted()
  762. end
  763. local function subscribeInner(...)
  764. if innerSubscription then
  765. innerSubscription:unsubscribe()
  766. end
  767. return util.tryWithObserver(observer, function(...)
  768. innerSubscription = callback(...):subscribe(onNext, onError)
  769. end, ...)
  770. end
  771. local subscription = self:subscribe(subscribeInner, onError, onCompleted)
  772. return Subscription.create(function()
  773. if innerSubscription then
  774. innerSubscription:unsubscribe()
  775. end
  776. if subscription then
  777. subscription:unsubscribe()
  778. end
  779. end)
  780. end)
  781. end
  782. --- Returns a new Observable that subscribes to the Observables produced by the original and
  783. -- produces their values.
  784. -- @returns {Observable}
  785. function Observable:flatten()
  786. return Observable.create(function(observer)
  787. local function onError(message)
  788. return observer:onError(message)
  789. end
  790. local function onNext(observable)
  791. local function innerOnNext(...)
  792. observer:onNext(...)
  793. end
  794. observable:subscribe(innerOnNext, onError, util.noop)
  795. end
  796. local function onCompleted()
  797. return observer:onCompleted()
  798. end
  799. return self:subscribe(onNext, onError, onCompleted)
  800. end)
  801. end
  802. --- Returns an Observable that terminates when the source terminates but does not produce any
  803. -- elements.
  804. -- @returns {Observable}
  805. function Observable:ignoreElements()
  806. return Observable.create(function(observer)
  807. local function onError(message)
  808. return observer:onError(message)
  809. end
  810. local function onCompleted()
  811. return observer:onCompleted()
  812. end
  813. return self:subscribe(nil, onError, onCompleted)
  814. end)
  815. end
  816. --- Returns a new Observable that only produces the last result of the original.
  817. -- @returns {Observable}
  818. function Observable:last()
  819. return Observable.create(function(observer)
  820. local value
  821. local empty = true
  822. local function onNext(...)
  823. value = {...}
  824. empty = false
  825. end
  826. local function onError(e)
  827. return observer:onError(e)
  828. end
  829. local function onCompleted()
  830. if not empty then
  831. observer:onNext(util.unpack(value or {}))
  832. end
  833. return observer:onCompleted()
  834. end
  835. return self:subscribe(onNext, onError, onCompleted)
  836. end)
  837. end
  838. --- Returns a new Observable that produces the values of the original transformed by a function.
  839. -- @arg {function} callback - The function to transform values from the original Observable.
  840. -- @returns {Observable}
  841. function Observable:map(callback)
  842. return Observable.create(function(observer)
  843. callback = callback or util.identity
  844. local function onNext(...)
  845. return util.tryWithObserver(observer, function(...)
  846. return observer:onNext(callback(...))
  847. end, ...)
  848. end
  849. local function onError(e)
  850. return observer:onError(e)
  851. end
  852. local function onCompleted()
  853. return observer:onCompleted()
  854. end
  855. return self:subscribe(onNext, onError, onCompleted)
  856. end)
  857. end
  858. --- Returns a new Observable that produces the maximum value produced by the original.
  859. -- @returns {Observable}
  860. function Observable:max()
  861. return self:reduce(math.max)
  862. end
  863. --- Returns a new Observable that produces the values produced by all the specified Observables in
  864. -- the order they are produced.
  865. -- @arg {Observable...} sources - One or more Observables to merge.
  866. -- @returns {Observable}
  867. function Observable:merge(...)
  868. local sources = {...}
  869. table.insert(sources, 1, self)
  870. return Observable.create(function(observer)
  871. local subscriptions = {}
  872. local function onNext(...)
  873. return observer:onNext(...)
  874. end
  875. local function onError(message)
  876. return observer:onError(message)
  877. end
  878. local function onCompleted(i)
  879. return function()
  880. sources[i] = nil
  881. if not next(sources) then
  882. observer:onCompleted()
  883. end
  884. end
  885. end
  886. for i = 1, #sources do
  887. subscriptions[i] = sources[i]:subscribe(onNext, onError, onCompleted(i))
  888. end
  889. return Subscription.create(function ()
  890. for i = 1, #sources do
  891. if subscriptions[i] then subscriptions[i]:unsubscribe() end
  892. end
  893. end)
  894. end)
  895. end
  896. --- Returns a new Observable that produces the minimum value produced by the original.
  897. -- @returns {Observable}
  898. function Observable:min()
  899. return self:reduce(math.min)
  900. end
  901. --- Returns an Observable that produces the values of the original inside tables.
  902. -- @returns {Observable}
  903. function Observable:pack()
  904. return self:map(util.pack)
  905. end
  906. --- Returns two Observables: one that produces values for which the predicate returns truthy for,
  907. -- and another that produces values for which the predicate returns falsy.
  908. -- @arg {function} predicate - The predicate used to partition the values.
  909. -- @returns {Observable}
  910. -- @returns {Observable}
  911. function Observable:partition(predicate)
  912. return self:filter(predicate), self:reject(predicate)
  913. end
  914. --- Returns a new Observable that produces values computed by extracting the given keys from the
  915. -- tables produced by the original.
  916. -- @arg {string...} keys - The key to extract from the table. Multiple keys can be specified to
  917. -- recursively pluck values from nested tables.
  918. -- @returns {Observable}
  919. function Observable:pluck(key, ...)
  920. if not key then return self end
  921. if type(key) ~= 'string' and type(key) ~= 'number' then
  922. return Observable.throw('pluck key must be a string')
  923. end
  924. return Observable.create(function(observer)
  925. local function onNext(t)
  926. return observer:onNext(t[key])
  927. end
  928. local function onError(e)
  929. return observer:onError(e)
  930. end
  931. local function onCompleted()
  932. return observer:onCompleted()
  933. end
  934. return self:subscribe(onNext, onError, onCompleted)
  935. end):pluck(...)
  936. end
  937. --- Returns a new Observable that produces a single value computed by accumulating the results of
  938. -- running a function on each value produced by the original Observable.
  939. -- @arg {function} accumulator - Accumulates the values of the original Observable. Will be passed
  940. -- the return value of the last call as the first argument and the
  941. -- current values as the rest of the arguments.
  942. -- @arg {*} seed - A value to pass to the accumulator the first time it is run.
  943. -- @returns {Observable}
  944. function Observable:reduce(accumulator, seed)
  945. return Observable.create(function(observer)
  946. local result = seed
  947. local first = true
  948. local function onNext(...)
  949. if first and seed == nil then
  950. result = ...
  951. first = false
  952. else
  953. return util.tryWithObserver(observer, function(...)
  954. result = accumulator(result, ...)
  955. end, ...)
  956. end
  957. end
  958. local function onError(e)
  959. return observer:onError(e)
  960. end
  961. local function onCompleted()
  962. observer:onNext(result)
  963. return observer:onCompleted()
  964. end
  965. return self:subscribe(onNext, onError, onCompleted)
  966. end)
  967. end
  968. --- Returns a new Observable that produces values from the original which do not satisfy a
  969. -- predicate.
  970. -- @arg {function} predicate - The predicate used to reject values.
  971. -- @returns {Observable}
  972. function Observable:reject(predicate)
  973. predicate = predicate or util.identity
  974. return Observable.create(function(observer)
  975. local function onNext(...)
  976. util.tryWithObserver(observer, function(...)
  977. if not predicate(...) then
  978. return observer:onNext(...)
  979. end
  980. end, ...)
  981. end
  982. local function onError(e)
  983. return observer:onError(e)
  984. end
  985. local function onCompleted()
  986. return observer:onCompleted()
  987. end
  988. return self:subscribe(onNext, onError, onCompleted)
  989. end)
  990. end
  991. --- Returns an Observable that restarts in the event of an error.
  992. -- @arg {number=} count - The maximum number of times to retry. If left unspecified, an infinite
  993. -- number of retries will be attempted.
  994. -- @returns {Observable}
  995. function Observable:retry(count)
  996. return Observable.create(function(observer)
  997. local subscription
  998. local retries = 0
  999. local function onNext(...)
  1000. return observer:onNext(...)
  1001. end
  1002. local function onCompleted()
  1003. return observer:onCompleted()
  1004. end
  1005. local function onError(message)
  1006. if subscription then
  1007. subscription:unsubscribe()
  1008. end
  1009. retries = retries + 1
  1010. if count and retries > count then
  1011. return observer:onError(message)
  1012. end
  1013. subscription = self:subscribe(onNext, onError, onCompleted)
  1014. end
  1015. return self:subscribe(onNext, onError, onCompleted)
  1016. end)
  1017. end
  1018. --- Returns a new Observable that produces its most recent value every time the specified observable
  1019. -- produces a value.
  1020. -- @arg {Observable} sampler - The Observable that is used to sample values from this Observable.
  1021. -- @returns {Observable}
  1022. function Observable:sample(sampler)
  1023. if not sampler then error('Expected an Observable') end
  1024. return Observable.create(function(observer)
  1025. local latest = {}
  1026. local function setLatest(...)
  1027. latest = util.pack(...)
  1028. end
  1029. local function onNext()
  1030. if #latest > 0 then
  1031. return observer:onNext(util.unpack(latest))
  1032. end
  1033. end
  1034. local function onError(message)
  1035. return observer:onError(message)
  1036. end
  1037. local function onCompleted()
  1038. return observer:onCompleted()
  1039. end
  1040. local sourceSubscription = self:subscribe(setLatest, onError)
  1041. local sampleSubscription = sampler:subscribe(onNext, onError, onCompleted)
  1042. return Subscription.create(function()
  1043. if sourceSubscription then sourceSubscription:unsubscribe() end
  1044. if sampleSubscription then sampleSubscription:unsubscribe() end
  1045. end)
  1046. end)
  1047. end
  1048. --- Returns a new Observable that produces values computed by accumulating the results of running a
  1049. -- function on each value produced by the original Observable.
  1050. -- @arg {function} accumulator - Accumulates the values of the original Observable. Will be passed
  1051. -- the return value of the last call as the first argument and the
  1052. -- current values as the rest of the arguments. Each value returned
  1053. -- from this function will be emitted by the Observable.
  1054. -- @arg {*} seed - A value to pass to the accumulator the first time it is run.
  1055. -- @returns {Observable}
  1056. function Observable:scan(accumulator, seed)
  1057. return Observable.create(function(observer)
  1058. local result = seed
  1059. local first = true
  1060. local function onNext(...)
  1061. if first and seed == nil then
  1062. result = ...
  1063. first = false
  1064. else
  1065. return util.tryWithObserver(observer, function(...)
  1066. result = accumulator(result, ...)
  1067. observer:onNext(result)
  1068. end, ...)
  1069. end
  1070. end
  1071. local function onError(e)
  1072. return observer:onError(e)
  1073. end
  1074. local function onCompleted()
  1075. return observer:onCompleted()
  1076. end
  1077. return self:subscribe(onNext, onError, onCompleted)
  1078. end)
  1079. end
  1080. --- Returns a new Observable that skips over a specified number of values produced by the original
  1081. -- and produces the rest.
  1082. -- @arg {number=1} n - The number of values to ignore.
  1083. -- @returns {Observable}
  1084. function Observable:skip(n)
  1085. n = n or 1
  1086. return Observable.create(function(observer)
  1087. local i = 1
  1088. local function onNext(...)
  1089. if i > n then
  1090. observer:onNext(...)
  1091. else
  1092. i = i + 1
  1093. end
  1094. end
  1095. local function onError(e)
  1096. return observer:onError(e)
  1097. end
  1098. local function onCompleted()
  1099. return observer:onCompleted()
  1100. end
  1101. return self:subscribe(onNext, onError, onCompleted)
  1102. end)
  1103. end
  1104. --- Returns an Observable that omits a specified number of values from the end of the original
  1105. -- Observable.
  1106. -- @arg {number} count - The number of items to omit from the end.
  1107. -- @returns {Observable}
  1108. function Observable:skipLast(count)
  1109. local buffer = {}
  1110. return Observable.create(function(observer)
  1111. local function emit()
  1112. if #buffer > count and buffer[1] then
  1113. local values = table.remove(buffer, 1)
  1114. observer:onNext(util.unpack(values))
  1115. end
  1116. end
  1117. local function onNext(...)
  1118. emit()
  1119. table.insert(buffer, util.pack(...))
  1120. end
  1121. local function onError(message)
  1122. return observer:onError(message)
  1123. end
  1124. local function onCompleted()
  1125. emit()
  1126. return observer:onCompleted()
  1127. end
  1128. return self:subscribe(onNext, onError, onCompleted)
  1129. end)
  1130. end
  1131. --- Returns a new Observable that skips over values produced by the original until the specified
  1132. -- Observable produces a value.
  1133. -- @arg {Observable} other - The Observable that triggers the production of values.
  1134. -- @returns {Observable}
  1135. function Observable:skipUntil(other)
  1136. return Observable.create(function(observer)
  1137. local triggered = false
  1138. local function trigger()
  1139. triggered = true
  1140. end
  1141. other:subscribe(trigger, trigger, trigger)
  1142. local function onNext(...)
  1143. if triggered then
  1144. observer:onNext(...)
  1145. end
  1146. end
  1147. local function onError()
  1148. if triggered then
  1149. observer:onError()
  1150. end
  1151. end
  1152. local function onCompleted()
  1153. if triggered then
  1154. observer:onCompleted()
  1155. end
  1156. end
  1157. return self:subscribe(onNext, onError, onCompleted)
  1158. end)
  1159. end
  1160. --- Returns a new Observable that skips elements until the predicate returns falsy for one of them.
  1161. -- @arg {function} predicate - The predicate used to continue skipping values.
  1162. -- @returns {Observable}
  1163. function Observable:skipWhile(predicate)
  1164. predicate = predicate or util.identity
  1165. return Observable.create(function(observer)
  1166. local skipping = true
  1167. local function onNext(...)
  1168. if skipping then
  1169. util.tryWithObserver(observer, function(...)
  1170. skipping = predicate(...)
  1171. end, ...)
  1172. end
  1173. if not skipping then
  1174. return observer:onNext(...)
  1175. end
  1176. end
  1177. local function onError(message)
  1178. return observer:onError(message)
  1179. end
  1180. local function onCompleted()
  1181. return observer:onCompleted()
  1182. end
  1183. return self:subscribe(onNext, onError, onCompleted)
  1184. end)
  1185. end
  1186. --- Returns a new Observable that produces the specified values followed by all elements produced by
  1187. -- the source Observable.
  1188. -- @arg {*...} values - The values to produce before the Observable begins producing values
  1189. -- normally.
  1190. -- @returns {Observable}
  1191. function Observable:startWith(...)
  1192. local values = util.pack(...)
  1193. return Observable.create(function(observer)
  1194. observer:onNext(util.unpack(values))
  1195. return self:subscribe(observer)
  1196. end)
  1197. end
  1198. --- Returns an Observable that produces a single value representing the sum of the values produced
  1199. -- by the original.
  1200. -- @returns {Observable}
  1201. function Observable:sum()
  1202. return self:reduce(function(x, y) return x + y end, 0)
  1203. end
  1204. --- Given an Observable that produces Observables, returns an Observable that produces the values
  1205. -- produced by the most recently produced Observable.
  1206. -- @returns {Observable}
  1207. function Observable:switch()
  1208. return Observable.create(function(observer)
  1209. local subscription
  1210. local function onNext(...)
  1211. return observer:onNext(...)
  1212. end
  1213. local function onError(message)
  1214. return observer:onError(message)
  1215. end
  1216. local function onCompleted()
  1217. return observer:onCompleted()
  1218. end
  1219. local function switch(source)
  1220. if subscription then
  1221. subscription:unsubscribe()
  1222. end
  1223. subscription = source:subscribe(onNext, onError, nil)
  1224. end
  1225. return self:subscribe(switch, onError, onCompleted)
  1226. end)
  1227. end
  1228. --- Returns a new Observable that only produces the first n results of the original.
  1229. -- @arg {number=1} n - The number of elements to produce before completing.
  1230. -- @returns {Observable}
  1231. function Observable:take(n)
  1232. n = n or 1
  1233. return Observable.create(function(observer)
  1234. if n <= 0 then
  1235. observer:onCompleted()
  1236. return
  1237. end
  1238. local i = 1
  1239. local function onNext(...)
  1240. observer:onNext(...)
  1241. i = i + 1
  1242. if i > n then
  1243. observer:onCompleted()
  1244. end
  1245. end
  1246. local function onError(e)
  1247. return observer:onError(e)
  1248. end
  1249. local function onCompleted()
  1250. return observer:onCompleted()
  1251. end
  1252. return self:subscribe(onNext, onError, onCompleted)
  1253. end)
  1254. end
  1255. --- Returns an Observable that produces a specified number of elements from the end of a source
  1256. -- Observable.
  1257. -- @arg {number} count - The number of elements to produce.
  1258. -- @returns {Observable}
  1259. function Observable:takeLast(count)
  1260. return Observable.create(function(observer)
  1261. local buffer = {}
  1262. local function onNext(...)
  1263. table.insert(buffer, util.pack(...))
  1264. if #buffer > count then
  1265. table.remove(buffer, 1)
  1266. end
  1267. end
  1268. local function onError(message)
  1269. return observer:onError(message)
  1270. end
  1271. local function onCompleted()
  1272. for i = 1, #buffer do
  1273. observer:onNext(util.unpack(buffer[i]))
  1274. end
  1275. return observer:onCompleted()
  1276. end
  1277. return self:subscribe(onNext, onError, onCompleted)
  1278. end)
  1279. end
  1280. --- Returns a new Observable that completes when the specified Observable fires.
  1281. -- @arg {Observable} other - The Observable that triggers completion of the original.
  1282. -- @returns {Observable}
  1283. function Observable:takeUntil(other)
  1284. return Observable.create(function(observer)
  1285. local function onNext(...)
  1286. return observer:onNext(...)
  1287. end
  1288. local function onError(e)
  1289. return observer:onError(e)
  1290. end
  1291. local function onCompleted()
  1292. return observer:onCompleted()
  1293. end
  1294. other:subscribe(onCompleted, onCompleted, onCompleted)
  1295. return self:subscribe(onNext, onError, onCompleted)
  1296. end)
  1297. end
  1298. --- Returns a new Observable that produces elements until the predicate returns falsy.
  1299. -- @arg {function} predicate - The predicate used to continue production of values.
  1300. -- @returns {Observable}
  1301. function Observable:takeWhile(predicate)
  1302. predicate = predicate or util.identity
  1303. return Observable.create(function(observer)
  1304. local taking = true
  1305. local function onNext(...)
  1306. if taking then
  1307. util.tryWithObserver(observer, function(...)
  1308. taking = predicate(...)
  1309. end, ...)
  1310. if taking then
  1311. return observer:onNext(...)
  1312. else
  1313. return observer:onCompleted()
  1314. end
  1315. end
  1316. end
  1317. local function onError(message)
  1318. return observer:onError(message)
  1319. end
  1320. local function onCompleted()
  1321. return observer:onCompleted()
  1322. end
  1323. return self:subscribe(onNext, onError, onCompleted)
  1324. end)
  1325. end
  1326. --- Runs a function each time this Observable has activity. Similar to subscribe but does not
  1327. -- create a subscription.
  1328. -- @arg {function=} onNext - Run when the Observable produces values.
  1329. -- @arg {function=} onError - Run when the Observable encounters a problem.
  1330. -- @arg {function=} onCompleted - Run when the Observable completes.
  1331. -- @returns {Observable}
  1332. function Observable:tap(_onNext, _onError, _onCompleted)
  1333. _onNext = _onNext or util.noop
  1334. _onError = _onError or util.noop
  1335. _onCompleted = _onCompleted or util.noop
  1336. return Observable.create(function(observer)
  1337. local function onNext(...)
  1338. util.tryWithObserver(observer, function(...)
  1339. _onNext(...)
  1340. end, ...)
  1341. return observer:onNext(...)
  1342. end
  1343. local function onError(message)
  1344. util.tryWithObserver(observer, function()
  1345. _onError(message)
  1346. end)
  1347. return observer:onError(message)
  1348. end
  1349. local function onCompleted()
  1350. util.tryWithObserver(observer, function()
  1351. _onCompleted()
  1352. end)
  1353. return observer:onCompleted()
  1354. end
  1355. return self:subscribe(onNext, onError, onCompleted)
  1356. end)
  1357. end
  1358. --- Returns an Observable that unpacks the tables produced by the original.
  1359. -- @returns {Observable}
  1360. function Observable:unpack()
  1361. return self:map(util.unpack)
  1362. end
  1363. --- Returns an Observable that takes any values produced by the original that consist of multiple
  1364. -- return values and produces each value individually.
  1365. -- @returns {Observable}
  1366. function Observable:unwrap()
  1367. return Observable.create(function(observer)
  1368. local function onNext(...)
  1369. local values = {...}
  1370. for i = 1, #values do
  1371. observer:onNext(values[i])
  1372. end
  1373. end
  1374. local function onError(message)
  1375. return observer:onError(message)
  1376. end
  1377. local function onCompleted()
  1378. return observer:onCompleted()
  1379. end
  1380. return self:subscribe(onNext, onError, onCompleted)
  1381. end)
  1382. end
  1383. --- Returns an Observable that produces a sliding window of the values produced by the original.
  1384. -- @arg {number} size - The size of the window. The returned observable will produce this number
  1385. -- of the most recent values as multiple arguments to onNext.
  1386. -- @returns {Observable}
  1387. function Observable:window(size)
  1388. return Observable.create(function(observer)
  1389. local window = {}
  1390. local function onNext(value)
  1391. table.insert(window, value)
  1392. if #window >= size then
  1393. observer:onNext(util.unpack(window))
  1394. table.remove(window, 1)
  1395. end
  1396. end
  1397. local function onError(message)
  1398. return observer:onError(message)
  1399. end
  1400. local function onCompleted()
  1401. return observer:onCompleted()
  1402. end
  1403. return self:subscribe(onNext, onError, onCompleted)
  1404. end)
  1405. end
  1406. --- Returns an Observable that produces values from the original along with the most recently
  1407. -- produced value from all other specified Observables. Note that only the first argument from each
  1408. -- source Observable is used.
  1409. -- @arg {Observable...} sources - The Observables to include the most recent values from.
  1410. -- @returns {Observable}
  1411. function Observable:with(...)
  1412. local sources = {...}
  1413. return Observable.create(function(observer)
  1414. local latest = setmetatable({}, {__len = util.constant(#sources)})
  1415. local function setLatest(i)
  1416. return function(value)
  1417. latest[i] = value
  1418. end
  1419. end
  1420. local function onNext(value)
  1421. return observer:onNext(value, util.unpack(latest))
  1422. end
  1423. local function onError(e)
  1424. return observer:onError(e)
  1425. end
  1426. local function onCompleted()
  1427. return observer:onCompleted()
  1428. end
  1429. for i = 1, #sources do
  1430. sources[i]:subscribe(setLatest(i), util.noop, util.noop)
  1431. end
  1432. return self:subscribe(onNext, onError, onCompleted)
  1433. end)
  1434. end
  1435. --- Returns an Observable that merges the values produced by the source Observables by grouping them
  1436. -- by their index. The first onNext event contains the first value of all of the sources, the
  1437. -- second onNext event contains the second value of all of the sources, and so on. onNext is called
  1438. -- a number of times equal to the number of values produced by the Observable that produces the
  1439. -- fewest number of values.
  1440. -- @arg {Observable...} sources - The Observables to zip.
  1441. -- @returns {Observable}
  1442. function Observable.zip(...)
  1443. local sources = util.pack(...)
  1444. local count = #sources
  1445. return Observable.create(function(observer)
  1446. local values = {}
  1447. local active = {}
  1448. for i = 1, count do
  1449. values[i] = {n = 0}
  1450. active[i] = true
  1451. end
  1452. local function onNext(i)
  1453. return function(value)
  1454. table.insert(values[i], value)
  1455. values[i].n = values[i].n + 1
  1456. local ready = true
  1457. for i = 1, count do
  1458. if values[i].n == 0 then
  1459. ready = false
  1460. break
  1461. end
  1462. end
  1463. if ready then
  1464. local payload = {}
  1465. for i = 1, count do
  1466. payload[i] = table.remove(values[i], 1)
  1467. values[i].n = values[i].n - 1
  1468. end
  1469. observer:onNext(util.unpack(payload))
  1470. end
  1471. end
  1472. end
  1473. local function onError(message)
  1474. return observer:onError(message)
  1475. end
  1476. local function onCompleted(i)
  1477. return function()
  1478. active[i] = nil
  1479. if not next(active) or values[i].n == 0 then
  1480. return observer:onCompleted()
  1481. end
  1482. end
  1483. end
  1484. for i = 1, count do
  1485. sources[i]:subscribe(onNext(i), onError, onCompleted(i))
  1486. end
  1487. end)
  1488. end
  1489. --- @class ImmediateScheduler
  1490. -- @description Schedules Observables by running all operations immediately.
  1491. local ImmediateScheduler = {}
  1492. ImmediateScheduler.__index = ImmediateScheduler
  1493. ImmediateScheduler.__tostring = util.constant('ImmediateScheduler')
  1494. --- Creates a new ImmediateScheduler.
  1495. -- @returns {ImmediateScheduler}
  1496. function ImmediateScheduler.create()
  1497. return setmetatable({}, ImmediateScheduler)
  1498. end
  1499. --- Schedules a function to be run on the scheduler. It is executed immediately.
  1500. -- @arg {function} action - The function to execute.
  1501. function ImmediateScheduler:schedule(action)
  1502. action()
  1503. end
  1504. --- @class CooperativeScheduler
  1505. -- @description Manages Observables using coroutines and a virtual clock that must be updated
  1506. -- manually.
  1507. local CooperativeScheduler = {}
  1508. CooperativeScheduler.__index = CooperativeScheduler
  1509. CooperativeScheduler.__tostring = util.constant('CooperativeScheduler')
  1510. --- Creates a new CooperativeScheduler.
  1511. -- @arg {number=0} currentTime - A time to start the scheduler at.
  1512. -- @returns {CooperativeScheduler}
  1513. function CooperativeScheduler.create(currentTime)
  1514. local self = {
  1515. tasks = {},
  1516. currentTime = currentTime or 0
  1517. }
  1518. return setmetatable(self, CooperativeScheduler)
  1519. end
  1520. --- Schedules a function to be run after an optional delay. Returns a subscription that will stop
  1521. -- the action from running.
  1522. -- @arg {function} action - The function to execute. Will be converted into a coroutine. The
  1523. -- coroutine may yield execution back to the scheduler with an optional
  1524. -- number, which will put it to sleep for a time period.
  1525. -- @arg {number=0} delay - Delay execution of the action by a virtual time period.
  1526. -- @returns {Subscription}
  1527. function CooperativeScheduler:schedule(action, delay)
  1528. local task = {
  1529. thread = coroutine.create(action),
  1530. due = self.currentTime + (delay or 0)
  1531. }
  1532. table.insert(self.tasks, task)
  1533. return Subscription.create(function()
  1534. return self:unschedule(task)
  1535. end)
  1536. end
  1537. function CooperativeScheduler:unschedule(task)
  1538. for i = 1, #self.tasks do
  1539. if self.tasks[i] == task then
  1540. table.remove(self.tasks, i)
  1541. end
  1542. end
  1543. end
  1544. --- Triggers an update of the CooperativeScheduler. The clock will be advanced and the scheduler
  1545. -- will run any coroutines that are due to be run.
  1546. -- @arg {number=0} delta - An amount of time to advance the clock by. It is common to pass in the
  1547. -- time in seconds or milliseconds elapsed since this function was last
  1548. -- called.
  1549. function CooperativeScheduler:update(delta)
  1550. self.currentTime = self.currentTime + (delta or 0)
  1551. local i = 1
  1552. while i <= #self.tasks do
  1553. local task = self.tasks[i]
  1554. if self.currentTime >= task.due then
  1555. local success, delay = coroutine.resume(task.thread)
  1556. if coroutine.status(task.thread) == 'dead' then
  1557. table.remove(self.tasks, i)
  1558. else
  1559. task.due = math.max(task.due + (delay or 0), self.currentTime)
  1560. i = i + 1
  1561. end
  1562. if not success then
  1563. error(delay)
  1564. end
  1565. else
  1566. i = i + 1
  1567. end
  1568. end
  1569. end
  1570. --- Returns whether or not the CooperativeScheduler's queue is empty.
  1571. function CooperativeScheduler:isEmpty()
  1572. return not next(self.tasks)
  1573. end
  1574. --- @class TimeoutScheduler
  1575. -- @description A scheduler that uses luvit's timer library to schedule events on an event loop.
  1576. local TimeoutScheduler = {}
  1577. TimeoutScheduler.__index = TimeoutScheduler
  1578. TimeoutScheduler.__tostring = util.constant('TimeoutScheduler')
  1579. --- Creates a new TimeoutScheduler.
  1580. -- @returns {TimeoutScheduler}
  1581. function TimeoutScheduler.create()
  1582. return setmetatable({}, TimeoutScheduler)
  1583. end
  1584. --- Schedules an action to run at a future point in time.
  1585. -- @arg {function} action - The action to run.
  1586. -- @arg {number=0} delay - The delay, in milliseconds.
  1587. -- @returns {Subscription}
  1588. function TimeoutScheduler:schedule(action, delay, ...)
  1589. local timer = require 'timer'
  1590. local subscription
  1591. local handle = timer.setTimeout(delay, action, ...)
  1592. return Subscription.create(function()
  1593. timer.clearTimeout(handle)
  1594. end)
  1595. end
  1596. --- @class Subject
  1597. -- @description Subjects function both as an Observer and as an Observable. Subjects inherit all
  1598. -- Observable functions, including subscribe. Values can also be pushed to the Subject, which will
  1599. -- be broadcasted to any subscribed Observers.
  1600. local Subject = setmetatable({}, Observable)
  1601. Subject.__index = Subject
  1602. Subject.__tostring = util.constant('Subject')
  1603. --- Creates a new Subject.
  1604. -- @returns {Subject}
  1605. function Subject.create()
  1606. local self = {
  1607. observers = {},
  1608. stopped = false
  1609. }
  1610. return setmetatable(self, Subject)
  1611. end
  1612. --- Creates a new Observer and attaches it to the Subject.
  1613. -- @arg {function|table} onNext|observer - A function called when the Subject produces a value or
  1614. -- an existing Observer to attach to the Subject.
  1615. -- @arg {function} onError - Called when the Subject terminates due to an error.
  1616. -- @arg {function} onCompleted - Called when the Subject completes normally.
  1617. function Subject:subscribe(onNext, onError, onCompleted)
  1618. local observer
  1619. if util.isa(onNext, Observer) then
  1620. observer = onNext
  1621. else
  1622. observer = Observer.create(onNext, onError, onCompleted)
  1623. end
  1624. table.insert(self.observers, observer)
  1625. return Subscription.create(function()
  1626. for i = 1, #self.observers do
  1627. if self.observers[i] == observer then
  1628. table.remove(self.observers, i)
  1629. return
  1630. end
  1631. end
  1632. end)
  1633. end
  1634. --- Pushes zero or more values to the Subject. They will be broadcasted to all Observers.
  1635. -- @arg {*...} values
  1636. function Subject:onNext(...)
  1637. if not self.stopped then
  1638. for i = 1, #self.observers do
  1639. self.observers[i]:onNext(...)
  1640. end
  1641. end
  1642. end
  1643. --- Signal to all Observers that an error has occurred.
  1644. -- @arg {string=} message - A string describing what went wrong.
  1645. function Subject:onError(message)
  1646. if not self.stopped then
  1647. for i = 1, #self.observers do
  1648. self.observers[i]:onError(message)
  1649. end
  1650. self.stopped = true
  1651. end
  1652. end
  1653. --- Signal to all Observers that the Subject will not produce any more values.
  1654. function Subject:onCompleted()
  1655. if not self.stopped then
  1656. for i = 1, #self.observers do
  1657. self.observers[i]:onCompleted()
  1658. end
  1659. self.stopped = true
  1660. end
  1661. end
  1662. Subject.__call = Subject.onNext
  1663. --- @class AsyncSubject
  1664. -- @description AsyncSubjects are subjects that produce either no values or a single value. If
  1665. -- multiple values are produced via onNext, only the last one is used. If onError is called, then
  1666. -- no value is produced and onError is called on any subscribed Observers. If an Observer
  1667. -- subscribes and the AsyncSubject has already terminated, the Observer will immediately receive the
  1668. -- value or the error.
  1669. local AsyncSubject = setmetatable({}, Observable)
  1670. AsyncSubject.__index = AsyncSubject
  1671. AsyncSubject.__tostring = util.constant('AsyncSubject')
  1672. --- Creates a new AsyncSubject.
  1673. -- @returns {AsyncSubject}
  1674. function AsyncSubject.create()
  1675. local self = {
  1676. observers = {},
  1677. stopped = false,
  1678. value = nil,
  1679. errorMessage = nil
  1680. }
  1681. return setmetatable(self, AsyncSubject)
  1682. end
  1683. --- Creates a new Observer and attaches it to the AsyncSubject.
  1684. -- @arg {function|table} onNext|observer - A function called when the AsyncSubject produces a value
  1685. -- or an existing Observer to attach to the AsyncSubject.
  1686. -- @arg {function} onError - Called when the AsyncSubject terminates due to an error.
  1687. -- @arg {function} onCompleted - Called when the AsyncSubject completes normally.
  1688. function AsyncSubject:subscribe(onNext, onError, onCompleted)
  1689. local observer
  1690. if util.isa(onNext, Observer) then
  1691. observer = onNext
  1692. else
  1693. observer = Observer.create(onNext, onError, onCompleted)
  1694. end
  1695. if self.value then
  1696. observer:onNext(util.unpack(self.value))
  1697. observer:onCompleted()
  1698. return
  1699. elseif self.errorMessage then
  1700. observer:onError(self.errorMessage)
  1701. return
  1702. end
  1703. table.insert(self.observers, observer)
  1704. return Subscription.create(function()
  1705. for i = 1, #self.observers do
  1706. if self.observers[i] == observer then
  1707. table.remove(self.observers, i)
  1708. return
  1709. end
  1710. end
  1711. end)
  1712. end
  1713. --- Pushes zero or more values to the AsyncSubject.
  1714. -- @arg {*...} values
  1715. function AsyncSubject:onNext(...)
  1716. if not self.stopped then
  1717. self.value = util.pack(...)
  1718. end
  1719. end
  1720. --- Signal to all Observers that an error has occurred.
  1721. -- @arg {string=} message - A string describing what went wrong.
  1722. function AsyncSubject:onError(message)
  1723. if not self.stopped then
  1724. self.errorMessage = message
  1725. for i = 1, #self.observers do
  1726. self.observers[i]:onError(self.errorMessage)
  1727. end
  1728. self.stopped = true
  1729. end
  1730. end
  1731. --- Signal to all Observers that the AsyncSubject will not produce any more values.
  1732. function AsyncSubject:onCompleted()
  1733. if not self.stopped then
  1734. for i = 1, #self.observers do
  1735. if self.value then
  1736. self.observers[i]:onNext(util.unpack(self.value))
  1737. end
  1738. self.observers[i]:onCompleted()
  1739. end
  1740. self.stopped = true
  1741. end
  1742. end
  1743. AsyncSubject.__call = AsyncSubject.onNext
  1744. --- @class BehaviorSubject
  1745. -- @description A Subject that tracks its current value. Provides an accessor to retrieve the most
  1746. -- recent pushed value, and all subscribers immediately receive the latest value.
  1747. local BehaviorSubject = setmetatable({}, Subject)
  1748. BehaviorSubject.__index = BehaviorSubject
  1749. BehaviorSubject.__tostring = util.constant('BehaviorSubject')
  1750. --- Creates a new BehaviorSubject.
  1751. -- @arg {*...} value - The initial values.
  1752. -- @returns {BehaviorSubject}
  1753. function BehaviorSubject.create(...)
  1754. local self = {
  1755. observers = {},
  1756. stopped = false
  1757. }
  1758. if select('#', ...) > 0 then
  1759. self.value = util.pack(...)
  1760. end
  1761. return setmetatable(self, BehaviorSubject)
  1762. end
  1763. --- Creates a new Observer and attaches it to the BehaviorSubject. Immediately broadcasts the most
  1764. -- recent value to the Observer.
  1765. -- @arg {function} onNext - Called when the BehaviorSubject produces a value.
  1766. -- @arg {function} onError - Called when the BehaviorSubject terminates due to an error.
  1767. -- @arg {function} onCompleted - Called when the BehaviorSubject completes normally.
  1768. function BehaviorSubject:subscribe(onNext, onError, onCompleted)
  1769. local observer
  1770. if util.isa(onNext, Observer) then
  1771. observer = onNext
  1772. else
  1773. observer = Observer.create(onNext, onError, onCompleted)
  1774. end
  1775. local subscription = Subject.subscribe(self, observer)
  1776. if self.value then
  1777. observer:onNext(util.unpack(self.value))
  1778. end
  1779. return subscription
  1780. end
  1781. --- Pushes zero or more values to the BehaviorSubject. They will be broadcasted to all Observers.
  1782. -- @arg {*...} values
  1783. function BehaviorSubject:onNext(...)
  1784. self.value = util.pack(...)
  1785. return Subject.onNext(self, ...)
  1786. end
  1787. --- Returns the last value emitted by the BehaviorSubject, or the initial value passed to the
  1788. -- constructor if nothing has been emitted yet.
  1789. -- @returns {*...}
  1790. function BehaviorSubject:getValue()
  1791. if self.value ~= nil then
  1792. return util.unpack(self.value)
  1793. end
  1794. end
  1795. BehaviorSubject.__call = BehaviorSubject.onNext
  1796. --- @class ReplaySubject
  1797. -- @description A Subject that provides new Subscribers with some or all of the most recently
  1798. -- produced values upon subscription.
  1799. local ReplaySubject = setmetatable({}, Subject)
  1800. ReplaySubject.__index = ReplaySubject
  1801. ReplaySubject.__tostring = util.constant('ReplaySubject')
  1802. --- Creates a new ReplaySubject.
  1803. -- @arg {number=} bufferSize - The number of values to send to new subscribers. If nil, an infinite
  1804. -- buffer is used (note that this could lead to memory issues).
  1805. -- @returns {ReplaySubject}
  1806. function ReplaySubject.create(n)
  1807. local self = {
  1808. observers = {},
  1809. stopped = false,
  1810. buffer = {},
  1811. bufferSize = n
  1812. }
  1813. return setmetatable(self, ReplaySubject)
  1814. end
  1815. --- Creates a new Observer and attaches it to the ReplaySubject. Immediately broadcasts the most
  1816. -- contents of the buffer to the Observer.
  1817. -- @arg {function} onNext - Called when the ReplaySubject produces a value.
  1818. -- @arg {function} onError - Called when the ReplaySubject terminates due to an error.
  1819. -- @arg {function} onCompleted - Called when the ReplaySubject completes normally.
  1820. function ReplaySubject:subscribe(onNext, onError, onCompleted)
  1821. local observer
  1822. if util.isa(onNext, Observer) then
  1823. observer = onNext
  1824. else
  1825. observer = Observer.create(onNext, onError, onCompleted)
  1826. end
  1827. local subscription = Subject.subscribe(self, observer)
  1828. for i = 1, #self.buffer do
  1829. observer:onNext(util.unpack(self.buffer[i]))
  1830. end
  1831. return subscription
  1832. end
  1833. --- Pushes zero or more values to the ReplaySubject. They will be broadcasted to all Observers.
  1834. -- @arg {*...} values
  1835. function ReplaySubject:onNext(...)
  1836. table.insert(self.buffer, util.pack(...))
  1837. if self.bufferSize and #self.buffer > self.bufferSize then
  1838. table.remove(self.buffer, 1)
  1839. end
  1840. return Subject.onNext(self, ...)
  1841. end
  1842. ReplaySubject.__call = ReplaySubject.onNext
  1843. Observable.wrap = Observable.buffer
  1844. Observable['repeat'] = Observable.replicate
  1845. return {
  1846. util = util,
  1847. Subscription = Subscription,
  1848. Observer = Observer,
  1849. Observable = Observable,
  1850. ImmediateScheduler = ImmediateScheduler,
  1851. CooperativeScheduler = CooperativeScheduler,
  1852. TimeoutScheduler = TimeoutScheduler,
  1853. Subject = Subject,
  1854. AsyncSubject = AsyncSubject,
  1855. BehaviorSubject = BehaviorSubject,
  1856. ReplaySubject = ReplaySubject
  1857. }