rx.lua 63 KB

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