rx.lua 62 KB

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