rx.lua 39 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444
  1. -- RxLua v0.0.1
  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. --- @class Subscription
  12. -- @description A handle representing the link between an Observer and an Observable, as well as any
  13. -- work required to clean up after the Observable completes or the Observer unsubscribes.
  14. local Subscription = {}
  15. Subscription.__index = Subscription
  16. Subscription.__tostring = util.constant('Subscription')
  17. --- Creates a new Subscription.
  18. -- @arg {function=} action - The action to run when the subscription is unsubscribed. It will only
  19. -- be run once.
  20. -- @returns {Subscription}
  21. function Subscription.create(action)
  22. local self = {
  23. action = action or util.noop,
  24. unsubscribed = false
  25. }
  26. return setmetatable(self, Subscription)
  27. end
  28. --- Unsubscribes the subscription, performing any necessary cleanup work.
  29. function Subscription:unsubscribe()
  30. if self.unsubscribed then return end
  31. self.action(self)
  32. self.unsubscribed = true
  33. end
  34. --- @class Observer
  35. -- @description Observers are simple objects that receive values from Observables.
  36. local Observer = {}
  37. Observer.__index = Observer
  38. Observer.__tostring = util.constant('Observer')
  39. --- Creates a new Observer.
  40. -- @arg {function=} onNext - Called when the Observable produces a value.
  41. -- @arg {function=} onError - Called when the Observable terminates due to an error.
  42. -- @arg {function=} onCompleted - Called when the Observable completes normally.
  43. -- @returns {Observer}
  44. function Observer.create(onNext, onError, onCompleted)
  45. local self = {
  46. _onNext = onNext or util.noop,
  47. _onError = onError or error,
  48. _onCompleted = onCompleted or util.noop,
  49. stopped = false
  50. }
  51. return setmetatable(self, Observer)
  52. end
  53. --- Pushes zero or more values to the Observer.
  54. -- @arg {*...} values
  55. function Observer:onNext(...)
  56. if not self.stopped then
  57. self._onNext(...)
  58. end
  59. end
  60. --- Notify the Observer that an error has occurred.
  61. -- @arg {string=} message - A string describing what went wrong.
  62. function Observer:onError(message)
  63. if not self.stopped then
  64. self.stopped = true
  65. self._onError(message)
  66. end
  67. end
  68. --- Notify the Observer that the sequence has completed and will produce no more values.
  69. function Observer:onCompleted()
  70. if not self.stopped then
  71. self.stopped = true
  72. self._onCompleted()
  73. end
  74. end
  75. --- @class Observable
  76. -- @description Observables push values to Observers.
  77. local Observable = {}
  78. Observable.__index = Observable
  79. Observable.__tostring = util.constant('Observable')
  80. --- Creates a new Observable.
  81. -- @arg {function} subscribe - The subscription function that produces values.
  82. -- @returns {Observable}
  83. function Observable.create(subscribe)
  84. local self = {
  85. _subscribe = subscribe
  86. }
  87. return setmetatable(self, Observable)
  88. end
  89. --- Shorthand for creating an Observer and passing it to this Observable's subscription function.
  90. -- @arg {function} onNext - Called when the Observable produces a value.
  91. -- @arg {function} onError - Called when the Observable terminates due to an error.
  92. -- @arg {function} onCompleted - Called when the Observable completes normally.
  93. function Observable:subscribe(onNext, onError, onCompleted)
  94. if type(onNext) == 'table' then
  95. return self._subscribe(onNext)
  96. else
  97. return self._subscribe(Observer.create(onNext, onError, onCompleted))
  98. end
  99. end
  100. --- Returns an Observable that immediately completes without producing a value.
  101. function Observable.empty()
  102. return Observable.create(function(observer)
  103. observer:onCompleted()
  104. end)
  105. end
  106. --- Returns an Observable that never produces values and never completes.
  107. function Observable.never()
  108. return Observable.create(function(observer) end)
  109. end
  110. --- Returns an Observable that immediately produces an error.
  111. function Observable.throw(message)
  112. return Observable.create(function(observer)
  113. observer:onError(message)
  114. end)
  115. end
  116. --- Creates an Observable that produces a single value.
  117. -- @arg {*} value
  118. -- @returns {Observable}
  119. function Observable.fromValue(value)
  120. return Observable.create(function(observer)
  121. observer:onNext(value)
  122. observer:onCompleted()
  123. end)
  124. end
  125. --- Creates an Observable that produces a range of values in a manner similar to a Lua for loop.
  126. -- @arg {number} initial - The first value of the range, or the upper limit if no other arguments
  127. -- are specified.
  128. -- @arg {number=} limit - The second value of the range.
  129. -- @arg {number=1} step - An amount to increment the value by each iteration.
  130. -- @returns {Observable}
  131. function Observable.fromRange(initial, limit, step)
  132. if not limit and not step then
  133. initial, limit = 1, initial
  134. end
  135. step = step or 1
  136. return Observable.create(function(observer)
  137. for i = initial, limit, step do
  138. observer:onNext(i)
  139. end
  140. observer:onCompleted()
  141. end)
  142. end
  143. --- Creates an Observable that produces values from a table.
  144. -- @arg {table} table - The table used to create the Observable.
  145. -- @arg {function=pairs} iterator - An iterator used to iterate the table, e.g. pairs or ipairs.
  146. -- @arg {boolean} keys - Whether or not to also emit the keys of the table.
  147. -- @returns {Observable}
  148. function Observable.fromTable(t, iterator, keys)
  149. iterator = iterator or pairs
  150. return Observable.create(function(observer)
  151. for key, value in iterator(t) do
  152. observer:onNext(value, keys and key or nil)
  153. end
  154. observer:onCompleted()
  155. end)
  156. end
  157. --- Creates an Observable that produces values when the specified coroutine yields.
  158. -- @arg {thread} coroutine
  159. -- @returns {Observable}
  160. function Observable.fromCoroutine(thread, scheduler)
  161. thread = type(thread) == 'function' and coroutine.create(thread) or thread
  162. return Observable.create(function(observer)
  163. return scheduler:schedule(function()
  164. while not observer.stopped do
  165. local success, value = coroutine.resume(thread)
  166. if success then
  167. observer:onNext(value)
  168. else
  169. return observer:onError(value)
  170. end
  171. if coroutine.status(thread) == 'dead' then
  172. return observer:onCompleted()
  173. end
  174. coroutine.yield()
  175. end
  176. end)
  177. end)
  178. end
  179. --- Subscribes to this Observable and prints values it produces.
  180. -- @arg {string=} name - Prefixes the printed messages with a name.
  181. -- @arg {function=tostring} formatter - A function that formats one or more values to be printed.
  182. function Observable:dump(name, formatter)
  183. name = name and (name .. ' ') or ''
  184. formatter = formatter or tostring
  185. local onNext = function(...) print(name .. 'onNext: ' .. formatter(...)) end
  186. local onError = function(e) print(name .. 'onError: ' .. e) end
  187. local onCompleted = function() print(name .. 'onCompleted') end
  188. return self:subscribe(onNext, onError, onCompleted)
  189. end
  190. --- Determine whether all items emitted by an Observable meet some criteria.
  191. -- @arg {function=identity} predicate - The predicate used to evaluate objects.
  192. function Observable:all(predicate)
  193. predicate = predicate or util.identity
  194. return Observable.create(function(observer)
  195. local function onNext(...)
  196. if not predicate(...) then
  197. observer:onNext(false)
  198. observer:onCompleted()
  199. end
  200. end
  201. local function onError(e)
  202. return observer:onError(e)
  203. end
  204. local function onCompleted()
  205. observer:onNext(true)
  206. return observer:onCompleted()
  207. end
  208. return self:subscribe(onNext, onError, onCompleted)
  209. end)
  210. end
  211. --- Given a set of Observables, produces values from only the first one to produce a value.
  212. -- @arg {Observable...} observables
  213. -- @returns {Observable}
  214. function Observable.amb(a, b, ...)
  215. if not a or not b then return a end
  216. return Observable.create(function(observer)
  217. local subscriptionA, subscriptionB
  218. local function onNextA(...)
  219. if subscriptionB then subscriptionB:unsubscribe() end
  220. observer:onNext(...)
  221. end
  222. local function onErrorA(e)
  223. if subscriptionB then subscriptionB:unsubscribe() end
  224. observer:onError(e)
  225. end
  226. local function onCompletedA()
  227. if subscriptionB then subscriptionB:unsubscribe() end
  228. observer:onCompleted()
  229. end
  230. local function onNextB(...)
  231. if subscriptionA then subscriptionA:unsubscribe() end
  232. observer:onNext(...)
  233. end
  234. local function onErrorB(e)
  235. if subscriptionA then subscriptionA:unsubscribe() end
  236. observer:onError(e)
  237. end
  238. local function onCompletedB()
  239. if subscriptionA then subscriptionA:unsubscribe() end
  240. observer:onCompleted()
  241. end
  242. subscriptionA = a:subscribe(onNextA, onErrorA, onCompletedA)
  243. subscriptionB = b:subscribe(onNextB, onErrorB, onCompletedB)
  244. return Subscription.create(function()
  245. subscriptionA:unsubscribe()
  246. subscriptionB:unsubscribe()
  247. end)
  248. end):amb(...)
  249. end
  250. --- Returns an Observable that produces the average of all values produced by the original.
  251. -- @returns {Observable}
  252. function Observable:average()
  253. return Observable.create(function(observer)
  254. local sum, count = 0, 0
  255. local function onNext(value)
  256. sum = sum + value
  257. count = count + 1
  258. end
  259. local function onError(e)
  260. observer:onError(e)
  261. end
  262. local function onCompleted()
  263. if count > 0 then
  264. observer:onNext(sum / count)
  265. end
  266. observer:onCompleted()
  267. end
  268. return self:subscribe(onNext, onError, onCompleted)
  269. end)
  270. end
  271. --- Returns an Observable that buffers values from the original and produces them as multiple
  272. -- values.
  273. -- @arg {number} size - The size of the buffer.
  274. function Observable:buffer(size)
  275. return Observable.create(function(observer)
  276. local buffer = {}
  277. local function emit()
  278. if #buffer > 0 then
  279. observer:onNext(util.unpack(buffer))
  280. buffer = {}
  281. end
  282. end
  283. local function onNext(...)
  284. local values = {...}
  285. for i = 1, #values do
  286. table.insert(buffer, values[i])
  287. if #buffer >= size then
  288. emit()
  289. end
  290. end
  291. end
  292. local function onError(message)
  293. emit()
  294. return observer:onError(message)
  295. end
  296. local function onCompleted()
  297. emit()
  298. return observer:onCompleted()
  299. end
  300. return self:subscribe(onNext, onError, onCompleted)
  301. end)
  302. end
  303. --- Returns an Observable that intercepts any errors from the previous and replace them with values
  304. -- produced by a new Observable.
  305. -- @arg {function|Observable} handler - An Observable or a function that returns an Observable to
  306. -- replace the source Observable in the event of an error.
  307. -- @returns {Observable}
  308. function Observable:catch(handler)
  309. handler = handler and (type(handler) == 'function' and handler or util.constant(handler))
  310. return Observable.create(function(observer)
  311. local subscription
  312. local function onNext(...)
  313. return observer:onNext(...)
  314. end
  315. local function onError(e)
  316. if not handler then
  317. return observer:onCompleted()
  318. end
  319. local continue = handler(e)
  320. if continue then
  321. if subscription then subscription:unsubscribe() end
  322. continue:subscribe(observer)
  323. else
  324. observer:onError(e)
  325. end
  326. end
  327. local function onCompleted()
  328. observer:onCompleted()
  329. end
  330. subscription = self:subscribe(onNext, onError, onCompleted)
  331. return subscription
  332. end)
  333. end
  334. --- Returns a new Observable that runs a combinator function on the most recent values from a set
  335. -- of Observables whenever any of them produce a new value. The results of the combinator function
  336. -- are produced by the new Observable.
  337. -- @arg {Observable...} observables - One or more Observables to combine.
  338. -- @arg {function} combinator - A function that combines the latest result from each Observable and
  339. -- returns a single value.
  340. -- @returns {Observable}
  341. function Observable:combineLatest(...)
  342. local sources = {...}
  343. local combinator = table.remove(sources)
  344. if type(combinator) ~= 'function' then
  345. table.insert(sources, combinator)
  346. combinator = function(...) return ... end
  347. end
  348. table.insert(sources, 1, self)
  349. return Observable.create(function(observer)
  350. local latest = {}
  351. local pending = {util.unpack(sources)}
  352. local completed = {}
  353. local function onNext(i)
  354. return function(value)
  355. latest[i] = value
  356. pending[i] = nil
  357. if not next(pending) then
  358. observer:onNext(combinator(util.unpack(latest)))
  359. end
  360. end
  361. end
  362. local function onError(e)
  363. return observer:onError(e)
  364. end
  365. local function onCompleted(i)
  366. return function()
  367. table.insert(completed, i)
  368. if #completed == #sources then
  369. observer:onCompleted()
  370. end
  371. end
  372. end
  373. for i = 1, #sources do
  374. sources[i]:subscribe(onNext(i), onError, onCompleted(i))
  375. end
  376. end)
  377. end
  378. --- Returns a new Observable that produces the values of the first with falsy values removed.
  379. -- @returns {Observable}
  380. function Observable:compact()
  381. return self:filter(util.identity)
  382. end
  383. --- Returns a new Observable that produces the values produced by all the specified Observables in
  384. -- the order they are specified.
  385. -- @arg {Observable...} sources - The Observables to concatenate.
  386. -- @returns {Observable}
  387. function Observable:concat(other, ...)
  388. if not other then return self end
  389. local others = {...}
  390. return Observable.create(function(observer)
  391. local function onNext(...)
  392. return observer:onNext(...)
  393. end
  394. local function onError(message)
  395. return observer:onError(message)
  396. end
  397. local function onCompleted()
  398. return observer:onCompleted()
  399. end
  400. local function chain()
  401. return other:concat(util.unpack(others)):subscribe(onNext, onError, onCompleted)
  402. end
  403. return self:subscribe(onNext, onError, chain)
  404. end)
  405. end
  406. --- Returns a new Observable that produces a single boolean value representing whether or not the
  407. -- specified value was produced by the original.
  408. -- @arg {*} value - The value to search for. == is used for equality testing.
  409. -- @returns {Observable}
  410. function Observable:contains(value)
  411. return Observable.create(function(observer)
  412. local subscription
  413. local function onNext(...)
  414. local args = util.pack(...)
  415. if #args == 0 and value == nil then
  416. observer:onNext(true)
  417. if subscription then subscription:unsubscribe() end
  418. return observer:onCompleted()
  419. end
  420. for i = 1, #args do
  421. if args[i] == value then
  422. observer:onNext(true)
  423. if subscription then subscription:unsubscribe() end
  424. return observer:onCompleted()
  425. end
  426. end
  427. end
  428. local function onError(e)
  429. return observer:onError(e)
  430. end
  431. local function onCompleted()
  432. observer:onNext(false)
  433. return observer:onCompleted()
  434. end
  435. subscription = self:subscribe(onNext, onError, onCompleted)
  436. return subscription
  437. end)
  438. end
  439. --- Returns an Observable that produces a single value representing the number of values produced
  440. -- by the source value that satisfy an optional predicate.
  441. -- @arg {function=} predicate - The predicate used to match values.
  442. function Observable:count(predicate)
  443. predicate = predicate or util.constant(true)
  444. return Observable.create(function(observer)
  445. local count = 0
  446. local function onNext(...)
  447. if predicate(...) then
  448. count = count + 1
  449. end
  450. end
  451. local function onError(e)
  452. return observer:onError(e)
  453. end
  454. local function onCompleted()
  455. observer:onNext(count)
  456. observer:onCompleted()
  457. end
  458. return self:subscribe(onNext, onError, onCompleted)
  459. end)
  460. end
  461. --- Returns a new Observable that produces the values from the original with duplicates removed.
  462. -- @returns {Observable}
  463. function Observable:distinct()
  464. return Observable.create(function(observer)
  465. local values = {}
  466. local function onNext(x)
  467. if not values[x] then
  468. observer:onNext(x)
  469. end
  470. values[x] = true
  471. end
  472. local function onError(e)
  473. return observer:onError(e)
  474. end
  475. local function onCompleted()
  476. return observer:onCompleted()
  477. end
  478. return self:subscribe(onNext, onError, onCompleted)
  479. end)
  480. end
  481. --- Returns an Observable that only produces values from the original if they are different from
  482. -- the previous value.
  483. -- @arg {function} comparator - A function used to compare 2 values. If unspecified, == is used.
  484. -- @returns {Observable}
  485. function Observable:distinctUntilChanged(comparator)
  486. comparator = comparator or util.eq
  487. return Observable.create(function(observer)
  488. local first = true
  489. local currentValue = nil
  490. local function onNext(value, ...)
  491. if first or not comparator(value, currentValue) then
  492. observer:onNext(value, ...)
  493. currentValue = value
  494. first = false
  495. end
  496. end
  497. local function onError(message)
  498. return observer:onError(onError)
  499. end
  500. local function onCompleted()
  501. return observer:onCompleted()
  502. end
  503. return self:subscribe(onNext, onError, onCompleted)
  504. end)
  505. end
  506. --- Returns a new Observable that only produces values of the first that satisfy a predicate.
  507. -- @arg {function} predicate - The predicate used to filter values.
  508. -- @returns {Observable}
  509. function Observable:filter(predicate)
  510. predicate = predicate or util.identity
  511. return Observable.create(function(observer)
  512. local function onNext(...)
  513. if predicate(...) then
  514. return observer:onNext(...)
  515. end
  516. end
  517. local function onError(e)
  518. return observer:onError(e)
  519. end
  520. local function onCompleted()
  521. return observer:onCompleted(e)
  522. end
  523. return self:subscribe(onNext, onError, onCompleted)
  524. end)
  525. end
  526. --- Returns a new Observable that produces the first value of the original that satisfies a
  527. -- predicate.
  528. -- @arg {function} predicate - The predicate used to find a value.
  529. function Observable:find(predicate)
  530. predicate = predicate or util.identity
  531. return Observable.create(function(observer)
  532. local function onNext(...)
  533. if predicate(...) then
  534. observer:onNext(...)
  535. return observer:onCompleted()
  536. end
  537. end
  538. local function onError(message)
  539. return observer:onError(e)
  540. end
  541. local function onCompleted()
  542. return observer:onCompleted()
  543. end
  544. return self:subscribe(onNext, onError, onCompleted)
  545. end)
  546. end
  547. --- Returns a new Observable that only produces the first result of the original.
  548. -- @returns {Observable}
  549. function Observable:first()
  550. return self:take(1)
  551. end
  552. --- Returns a new Observable that subscribes to the Observables produced by the original and
  553. -- produces their values.
  554. -- @returns {Observable}
  555. function Observable:flatten()
  556. return Observable.create(function(observer)
  557. local function onError(message)
  558. return observer:onError(message)
  559. end
  560. local function onNext(observable)
  561. local function innerOnNext(...)
  562. observer:onNext(...)
  563. end
  564. observable:subscribe(innerOnNext, onError, util.noop)
  565. end
  566. local function onCompleted()
  567. return observer:onCompleted()
  568. end
  569. return self:subscribe(onNext, onError, onCompleted)
  570. end)
  571. end
  572. --- Returns a new Observable that only produces the last result of the original.
  573. -- @returns {Observable}
  574. function Observable:last()
  575. return Observable.create(function(observer)
  576. local value
  577. local empty = true
  578. local function onNext(...)
  579. value = {...}
  580. empty = false
  581. end
  582. local function onError(e)
  583. return observer:onError(e)
  584. end
  585. local function onCompleted()
  586. if not empty then
  587. observer:onNext(util.unpack(value or {}))
  588. end
  589. return observer:onCompleted()
  590. end
  591. return self:subscribe(onNext, onError, onCompleted)
  592. end)
  593. end
  594. --- Returns a new Observable that produces the values of the original transformed by a function.
  595. -- @arg {function} callback - The function to transform values from the original Observable.
  596. -- @returns {Observable}
  597. function Observable:map(callback)
  598. return Observable.create(function(observer)
  599. callback = callback or util.identity
  600. local function onNext(...)
  601. return observer:onNext(callback(...))
  602. end
  603. local function onError(e)
  604. return observer:onError(e)
  605. end
  606. local function onCompleted()
  607. return observer:onCompleted()
  608. end
  609. return self:subscribe(onNext, onError, onCompleted)
  610. end)
  611. end
  612. --- Returns a new Observable that produces the maximum value produced by the original.
  613. -- @returns {Observable}
  614. function Observable:max()
  615. return self:reduce(math.max)
  616. end
  617. --- Returns a new Observable that produces the values produced by all the specified Observables in
  618. -- the order they are produced.
  619. -- @arg {Observable...} sources - One or more Observables to merge.
  620. -- @returns {Observable}
  621. function Observable:merge(...)
  622. local sources = {...}
  623. table.insert(sources, 1, self)
  624. return Observable.create(function(observer)
  625. local function onNext(...)
  626. return observer:onNext(...)
  627. end
  628. local function onError(message)
  629. return observer:onError(message)
  630. end
  631. local function onCompleted(i)
  632. return function()
  633. sources[i] = nil
  634. if not next(sources) then
  635. observer:onCompleted()
  636. end
  637. end
  638. end
  639. for i = 1, #sources do
  640. sources[i]:subscribe(onNext, onError, onCompleted(i))
  641. end
  642. end)
  643. end
  644. --- Returns a new Observable that produces the minimum value produced by the original.
  645. -- @returns {Observable}
  646. function Observable:min()
  647. return self:reduce(math.min)
  648. end
  649. --- Returns an Observable that produces the values of the original inside tables.
  650. -- @returns {Observable}
  651. function Observable:pack()
  652. return self:map(util.pack)
  653. end
  654. --- Returns two Observables: one that produces values for which the predicate returns truthy for,
  655. -- and another that produces values for which the predicate returns falsy.
  656. -- @arg {function} predicate - The predicate used to partition the values.
  657. -- @returns {Observable}
  658. -- @returns {Observable}
  659. function Observable:partition(predicate)
  660. return self:filter(predicate), self:reject(predicate)
  661. end
  662. --- Returns a new Observable that produces values computed by extracting the given keys from the
  663. -- tables produced by the original.
  664. -- @arg {string...} keys - The key to extract from the table. Multiple keys can be specified to
  665. -- recursively pluck values from nested tables.
  666. -- @returns {Observable}
  667. function Observable:pluck(key, ...)
  668. if not key then return self end
  669. return Observable.create(function(observer)
  670. local function onNext(t)
  671. return observer:onNext(t[key])
  672. end
  673. local function onError(e)
  674. return observer:onError(e)
  675. end
  676. local function onCompleted()
  677. return observer:onCompleted()
  678. end
  679. return self:subscribe(onNext, onError, onCompleted)
  680. end):pluck(...)
  681. end
  682. --- Returns a new Observable that produces a single value computed by accumulating the results of
  683. -- running a function on each value produced by the original Observable.
  684. -- @arg {function} accumulator - Accumulates the values of the original Observable. Will be passed
  685. -- the return value of the last call as the first argument and the
  686. -- current values as the rest of the arguments.
  687. -- @arg {*} seed - A value to pass to the accumulator the first time it is run.
  688. -- @returns {Observable}
  689. function Observable:reduce(accumulator, seed)
  690. return Observable.create(function(observer)
  691. local result = seed
  692. local first = true
  693. local function onNext(...)
  694. if first and seed == nil then
  695. result = ...
  696. first = false
  697. else
  698. result = accumulator(result, ...)
  699. end
  700. end
  701. local function onError(e)
  702. return observer:onError(e)
  703. end
  704. local function onCompleted()
  705. observer:onNext(result)
  706. return observer:onCompleted()
  707. end
  708. return self:subscribe(onNext, onError, onCompleted)
  709. end)
  710. end
  711. --- Returns a new Observable that produces values from the original which do not satisfy a
  712. -- predicate.
  713. -- @arg {function} predicate - The predicate used to reject values.
  714. -- @returns {Observable}
  715. function Observable:reject(predicate)
  716. predicate = predicate or util.identity
  717. return Observable.create(function(observer)
  718. local function onNext(...)
  719. if not predicate(...) then
  720. return observer:onNext(...)
  721. end
  722. end
  723. local function onError(e)
  724. return observer:onError(e)
  725. end
  726. local function onCompleted()
  727. return observer:onCompleted(e)
  728. end
  729. return self:subscribe(onNext, onError, onCompleted)
  730. end)
  731. end
  732. --- Returns a new Observable that skips over a specified number of values produced by the original
  733. -- and produces the rest.
  734. -- @arg {number=1} n - The number of values to ignore.
  735. -- @returns {Observable}
  736. function Observable:skip(n)
  737. n = n or 1
  738. return Observable.create(function(observer)
  739. local i = 1
  740. local function onNext(...)
  741. if i > n then
  742. observer:onNext(...)
  743. else
  744. i = i + 1
  745. end
  746. end
  747. local function onError(e)
  748. return observer:onError(e)
  749. end
  750. local function onCompleted()
  751. return observer:onCompleted()
  752. end
  753. return self:subscribe(onNext, onError, onCompleted)
  754. end)
  755. end
  756. --- Returns a new Observable that skips over values produced by the original until the specified
  757. -- Observable produces a value.
  758. -- @arg {Observable} other - The Observable that triggers the production of values.
  759. -- @returns {Observable}
  760. function Observable:skipUntil(other)
  761. return Observable.create(function(observer)
  762. local triggered = false
  763. local function trigger()
  764. triggered = true
  765. end
  766. other:subscribe(trigger, trigger, trigger)
  767. local function onNext(...)
  768. if triggered then
  769. observer:onNext(...)
  770. end
  771. end
  772. local function onError()
  773. if triggered then
  774. observer:onError()
  775. end
  776. end
  777. local function onCompleted()
  778. if triggered then
  779. observer:onCompleted()
  780. end
  781. end
  782. return self:subscribe(onNext, onError, onCompleted)
  783. end)
  784. end
  785. --- Returns a new Observable that skips elements until the predicate returns falsy for one of them.
  786. -- @arg {function} predicate - The predicate used to continue skipping values.
  787. -- @returns {Observable}
  788. function Observable:skipWhile(predicate)
  789. predicate = predicate or util.identity
  790. return Observable.create(function(observer)
  791. local skipping = true
  792. local function onNext(...)
  793. if skipping then
  794. skipping = predicate(...)
  795. end
  796. if not skipping then
  797. return observer:onNext(...)
  798. end
  799. end
  800. local function onError(message)
  801. return observer:onError(message)
  802. end
  803. local function onCompleted()
  804. return observer:onCompleted()
  805. end
  806. return self:subscribe(onNext, onError, onCompleted)
  807. end)
  808. end
  809. --- Returns a new Observable that only produces the first n results of the original.
  810. -- @arg {number=1} n - The number of elements to produce before completing.
  811. -- @returns {Observable}
  812. function Observable:take(n)
  813. n = n or 1
  814. return Observable.create(function(observer)
  815. if n <= 0 then
  816. observer:onCompleted()
  817. return
  818. end
  819. local i = 1
  820. local function onNext(...)
  821. observer:onNext(...)
  822. i = i + 1
  823. if i > n then
  824. observer:onCompleted()
  825. end
  826. end
  827. local function onError(e)
  828. return observer:onError(e)
  829. end
  830. local function onCompleted()
  831. return observer:onCompleted()
  832. end
  833. return self:subscribe(onNext, onError, onCompleted)
  834. end)
  835. end
  836. --- Returns a new Observable that completes when the specified Observable fires.
  837. -- @arg {Observable} other - The Observable that triggers completion of the original.
  838. -- @returns {Observable}
  839. function Observable:takeUntil(other)
  840. return Observable.create(function(observer)
  841. local function onNext(...)
  842. return observer:onNext(...)
  843. end
  844. local function onError(e)
  845. return observer:onError(e)
  846. end
  847. local function onCompleted()
  848. return observer:onCompleted()
  849. end
  850. other:subscribe(onCompleted, onCompleted, onCompleted)
  851. return self:subscribe(onNext, onError, onCompleted)
  852. end)
  853. end
  854. --- Returns a new Observable that produces elements until the predicate returns falsy.
  855. -- @arg {function} predicate - The predicate used to continue production of values.
  856. -- @returns {Observable}
  857. function Observable:takeWhile(predicate)
  858. predicate = predicate or util.identity
  859. return Observable.create(function(observer)
  860. local taking = true
  861. local function onNext(...)
  862. if taking then
  863. taking = predicate(...)
  864. if taking then
  865. return observer:onNext(...)
  866. else
  867. return observer:onCompleted()
  868. end
  869. end
  870. end
  871. local function onError(message)
  872. return observer:onError(message)
  873. end
  874. local function onCompleted()
  875. return observer:onCompleted()
  876. end
  877. return self:subscribe(onNext, onError, onCompleted)
  878. end)
  879. end
  880. --- Runs a function each time this Observable has activity. Similar to subscribe but does not
  881. -- create a subscription.
  882. -- @arg {function=} onNext - Run when the Observable produces values.
  883. -- @arg {function=} onError - Run when the Observable encounters a problem.
  884. -- @arg {function=} onCompleted - Run when the Observable completes.
  885. -- @returns {Observable}
  886. function Observable:tap(_onNext, _onError, _onCompleted)
  887. _onNext = _onNext or util.noop
  888. _onError = _onError or util.noop
  889. _onCompleted = _onCompleted or util.noop
  890. return Observable.create(function(observer)
  891. local function onNext(...)
  892. _onNext(...)
  893. return observer:onNext(...)
  894. end
  895. local function onError(message)
  896. _onError(message)
  897. return observer:onError(message)
  898. end
  899. local function onCompleted()
  900. _onCompleted()
  901. return observer:onCompleted()
  902. end
  903. return self:subscribe(onNext, onError, onCompleted)
  904. end)
  905. end
  906. --- Returns an Observable that unpacks the tables produced by the original.
  907. -- @returns {Observable}
  908. function Observable:unpack()
  909. return self:map(util.unpack)
  910. end
  911. --- Returns an Observable that takes any values produced by the original that consist of multiple
  912. -- return values and produces each value individually.
  913. -- @returns {Observable}
  914. function Observable:unwrap()
  915. return Observable.create(function(observer)
  916. local function onNext(...)
  917. local values = {...}
  918. for i = 1, #values do
  919. observer:onNext(values[i])
  920. end
  921. end
  922. local function onError(message)
  923. return observer:onError(message)
  924. end
  925. local function onCompleted()
  926. return observer:onCompleted()
  927. end
  928. return self:subscribe(onNext, onError, onCompleted)
  929. end)
  930. end
  931. --- Returns an Observable that produces a sliding window of the values produced by the original.
  932. -- @arg {number} size - The size of the window. The returned observable will produce this number
  933. -- of the most recent values as multiple arguments to onNext.
  934. -- @returns {Observable}
  935. function Observable:window(size)
  936. return Observable.create(function(observer)
  937. local window = {}
  938. local function onNext(value)
  939. table.insert(window, value)
  940. if #window >= size then
  941. observer:onNext(util.unpack(window))
  942. table.remove(window, 1)
  943. end
  944. end
  945. local function onError(message)
  946. return observer:onError(message)
  947. end
  948. local function onCompleted()
  949. return observer:onCompleted()
  950. end
  951. return self:subscribe(onNext, onError, onCompleted)
  952. end)
  953. end
  954. --- Returns an Observable that produces values from the original along with the most recently
  955. -- produced value from all other specified Observables. Note that only the first argument from each
  956. -- source Observable is used.
  957. -- @arg {Observable...} sources - The Observables to include the most recent values from.
  958. -- @returns {Observable}
  959. function Observable:with(...)
  960. local sources = {...}
  961. return Observable.create(function(observer)
  962. local latest = setmetatable({}, {__len = util.constant(#sources)})
  963. local function setLatest(i)
  964. return function(value)
  965. latest[i] = value
  966. end
  967. end
  968. local function onNext(value)
  969. return observer:onNext(value, util.unpack(latest))
  970. end
  971. local function onError(e)
  972. return observer:onError(e)
  973. end
  974. local function onCompleted()
  975. return observer:onCompleted()
  976. end
  977. for i = 1, #sources do
  978. sources[i]:subscribe(setLatest(i), util.noop, util.noop)
  979. end
  980. return self:subscribe(onNext, onError, onCompleted)
  981. end)
  982. end
  983. --- @class ImmediateScheduler
  984. -- @description Schedules Observables by running all operations immediately.
  985. local ImmediateScheduler = {}
  986. ImmediateScheduler.__index = ImmediateScheduler
  987. ImmediateScheduler.__tostring = util.constant('ImmediateScheduler')
  988. --- Creates a new ImmediateScheduler.
  989. -- @returns {ImmediateScheduler}
  990. function ImmediateScheduler.create()
  991. return setmetatable({}, ImmediateScheduler)
  992. end
  993. --- Schedules a function to be run on the scheduler. It is executed immediately.
  994. -- @arg {function} action - The function to execute.
  995. function ImmediateScheduler:schedule(action)
  996. action()
  997. end
  998. --- @class CooperativeScheduler
  999. -- @description Manages Observables using coroutines and a virtual clock that must be updated
  1000. -- manually.
  1001. local CooperativeScheduler = {}
  1002. CooperativeScheduler.__index = CooperativeScheduler
  1003. CooperativeScheduler.__tostring = util.constant('CooperativeScheduler')
  1004. --- Creates a new CooperativeScheduler.
  1005. -- @arg {number=0} currentTime - A time to start the scheduler at.
  1006. -- @returns {Scheduler.CooperativeScheduler}
  1007. function CooperativeScheduler.create(currentTime)
  1008. local self = {
  1009. tasks = {},
  1010. currentTime = currentTime or 0
  1011. }
  1012. return setmetatable(self, CooperativeScheduler)
  1013. end
  1014. --- Schedules a function to be run after an optional delay.
  1015. -- @arg {function} action - The function to execute. Will be converted into a coroutine. The
  1016. -- coroutine may yield execution back to the scheduler with an optional
  1017. -- number, which will put it to sleep for a time period.
  1018. -- @arg {number=0} delay - Delay execution of the action by a time period.
  1019. function CooperativeScheduler:schedule(action, delay)
  1020. local task = {
  1021. thread = coroutine.create(action),
  1022. due = self.currentTime + (delay or 0)
  1023. }
  1024. table.insert(self.tasks, task)
  1025. return Subscription.create(function()
  1026. return self:unschedule(task)
  1027. end)
  1028. end
  1029. function CooperativeScheduler:unschedule(task)
  1030. for i = 1, #self.tasks do
  1031. if self.tasks[i] == task then
  1032. table.remove(self.tasks, i)
  1033. end
  1034. end
  1035. end
  1036. --- Triggers an update of the CooperativeScheduler. The clock will be advanced and the scheduler
  1037. -- will run any coroutines that are due to be run.
  1038. -- @arg {number=0} delta - An amount of time to advance the clock by. It is common to pass in the
  1039. -- time in seconds or milliseconds elapsed since this function was last
  1040. -- called.
  1041. function CooperativeScheduler:update(delta)
  1042. self.currentTime = self.currentTime + (delta or 0)
  1043. for i = #self.tasks, 1, -1 do
  1044. local task = self.tasks[i]
  1045. if self.currentTime >= task.due then
  1046. local success, delay = coroutine.resume(task.thread)
  1047. if success then
  1048. task.due = math.max(task.due + (delay or 0), self.currentTime)
  1049. else
  1050. error(delay)
  1051. end
  1052. if coroutine.status(task.thread) == 'dead' then
  1053. table.remove(self.tasks, i)
  1054. end
  1055. end
  1056. end
  1057. end
  1058. --- Returns whether or not the CooperativeScheduler's queue is empty.
  1059. function CooperativeScheduler:isEmpty()
  1060. return not next(self.tasks)
  1061. end
  1062. --- @class Subject
  1063. -- @description Subjects function both as an Observer and as an Observable. Subjects inherit all
  1064. -- Observable functions, including subscribe. Values can also be pushed to the Subject, which will
  1065. -- be broadcasted to any subscribed Observers.
  1066. local Subject = setmetatable({}, Observable)
  1067. Subject.__index = Subject
  1068. Subject.__tostring = util.constant('Subject')
  1069. --- Creates a new Subject.
  1070. -- @returns {Subject}
  1071. function Subject.create()
  1072. local self = {
  1073. observers = {},
  1074. stopped = false
  1075. }
  1076. return setmetatable(self, Subject)
  1077. end
  1078. --- Creates a new Observer and attaches it to the Subject.
  1079. -- @arg {function|table} onNext|observer - A function called when the Subject produces a value or
  1080. -- an existing Observer to attach to the Subject.
  1081. -- @arg {function} onError - Called when the Subject terminates due to an error.
  1082. -- @arg {function} onCompleted - Called when the Subject completes normally.
  1083. function Subject:subscribe(onNext, onError, onCompleted)
  1084. local observer
  1085. if type(onNext) == 'table' then
  1086. observer = onNext
  1087. else
  1088. observer = Observer.create(onNext, onError, onCompleted)
  1089. end
  1090. table.insert(self.observers, observer)
  1091. return Subscription.create(function()
  1092. for i = 1, #self.observers do
  1093. if self.observers[i] == observer then
  1094. table.remove(self.observers, i)
  1095. return
  1096. end
  1097. end
  1098. end)
  1099. end
  1100. --- Pushes zero or more values to the Subject. They will be broadcasted to all Observers.
  1101. -- @arg {*...} values
  1102. function Subject:onNext(...)
  1103. if not self.stopped then
  1104. for i = 1, #self.observers do
  1105. self.observers[i]:onNext(...)
  1106. end
  1107. end
  1108. end
  1109. --- Signal to all Observers that an error has occurred.
  1110. -- @arg {string=} message - A string describing what went wrong.
  1111. function Subject:onError(message)
  1112. if not self.stopped then
  1113. for i = 1, #self.observers do
  1114. self.observers[i]:onError(message)
  1115. end
  1116. self.stopped = true
  1117. end
  1118. end
  1119. --- Signal to all Observers that the Subject will not produce any more values.
  1120. function Subject:onCompleted()
  1121. if not self.stopped then
  1122. for i = 1, #self.observers do
  1123. self.observers[i]:onCompleted()
  1124. end
  1125. self.stopped = true
  1126. end
  1127. end
  1128. Subject.__call = Subject.onNext
  1129. --- @class BehaviorSubject
  1130. -- @description A Subject that tracks its current value. Provides an accessor to retrieve the most
  1131. -- recent pushed value, and all subscribers immediately receive the latest value.
  1132. local BehaviorSubject = setmetatable({}, Subject)
  1133. BehaviorSubject.__index = BehaviorSubject
  1134. BehaviorSubject.__tostring = util.constant('BehaviorSubject')
  1135. --- Creates a new BehaviorSubject.
  1136. -- @arg {*...} value - The initial values.
  1137. -- @returns {Subject}
  1138. function BehaviorSubject.create(...)
  1139. local self = {
  1140. observers = {},
  1141. stopped = false
  1142. }
  1143. if select('#', ...) > 0 then
  1144. self.value = util.pack(...)
  1145. end
  1146. return setmetatable(self, BehaviorSubject)
  1147. end
  1148. --- Creates a new Observer and attaches it to the Subject. Immediately broadcasts the most recent
  1149. -- value to the Observer.
  1150. -- @arg {function} onNext - Called when the Subject produces a value.
  1151. -- @arg {function} onError - Called when the Subject terminates due to an error.
  1152. -- @arg {function} onCompleted - Called when the Subject completes normally.
  1153. function BehaviorSubject:subscribe(onNext, onError, onCompleted)
  1154. local observer = Observer.create(onNext, onError, onCompleted)
  1155. Subject.subscribe(self, observer)
  1156. if self.value then
  1157. observer:onNext(unpack(self.value))
  1158. end
  1159. end
  1160. --- Pushes zero or more values to the BehaviorSubject. They will be broadcasted to all Observers.
  1161. -- @arg {*...} values
  1162. function BehaviorSubject:onNext(...)
  1163. self.value = util.pack(...)
  1164. return Subject.onNext(self, ...)
  1165. end
  1166. --- Returns the last value emitted by the Subject, or the initial value passed to the constructor
  1167. -- if nothing has been emitted yet.
  1168. -- @returns {*...}
  1169. function BehaviorSubject:getValue()
  1170. return self.value and util.unpack(self.value)
  1171. end
  1172. Observable.wrap = Observable.buffer
  1173. return {
  1174. util = util,
  1175. Subscription = Subscription,
  1176. Observer = Observer,
  1177. Observable = Observable,
  1178. ImmediateScheduler = ImmediateScheduler,
  1179. CooperativeScheduler = CooperativeScheduler,
  1180. Subject = Subject,
  1181. BehaviorSubject = BehaviorSubject
  1182. }