rx.lua 59 KB

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