rx.lua 63 KB

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