rx.lua 62 KB

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