rx.lua 61 KB

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