rx.lua 48 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728
  1. -- RxLua v0.0.1
  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. --- @class Subscription
  12. -- @description A handle representing the link between an Observer and an Observable, as well as any
  13. -- work required to clean up after the Observable completes or the Observer unsubscribes.
  14. local Subscription = {}
  15. Subscription.__index = Subscription
  16. Subscription.__tostring = util.constant('Subscription')
  17. --- Creates a new Subscription.
  18. -- @arg {function=} action - The action to run when the subscription is unsubscribed. It will only
  19. -- be run once.
  20. -- @returns {Subscription}
  21. function Subscription.create(action)
  22. local self = {
  23. action = action or util.noop,
  24. unsubscribed = false
  25. }
  26. return setmetatable(self, Subscription)
  27. end
  28. --- Unsubscribes the subscription, performing any necessary cleanup work.
  29. function Subscription:unsubscribe()
  30. if self.unsubscribed then return end
  31. self.action(self)
  32. self.unsubscribed = true
  33. end
  34. --- @class Observer
  35. -- @description Observers are simple objects that receive values from Observables.
  36. local Observer = {}
  37. Observer.__index = Observer
  38. Observer.__tostring = util.constant('Observer')
  39. --- Creates a new Observer.
  40. -- @arg {function=} onNext - Called when the Observable produces a value.
  41. -- @arg {function=} onError - Called when the Observable terminates due to an error.
  42. -- @arg {function=} onCompleted - Called when the Observable completes normally.
  43. -- @returns {Observer}
  44. function Observer.create(onNext, onError, onCompleted)
  45. local self = {
  46. _onNext = onNext or util.noop,
  47. _onError = onError or error,
  48. _onCompleted = onCompleted or util.noop,
  49. stopped = false
  50. }
  51. return setmetatable(self, Observer)
  52. end
  53. --- Pushes zero or more values to the Observer.
  54. -- @arg {*...} values
  55. function Observer:onNext(...)
  56. if not self.stopped then
  57. self._onNext(...)
  58. end
  59. end
  60. --- Notify the Observer that an error has occurred.
  61. -- @arg {string=} message - A string describing what went wrong.
  62. function Observer:onError(message)
  63. if not self.stopped then
  64. self.stopped = true
  65. self._onError(message)
  66. end
  67. end
  68. --- Notify the Observer that the sequence has completed and will produce no more values.
  69. function Observer:onCompleted()
  70. if not self.stopped then
  71. self.stopped = true
  72. self._onCompleted()
  73. end
  74. end
  75. --- @class Observable
  76. -- @description Observables push values to Observers.
  77. local Observable = {}
  78. Observable.__index = Observable
  79. Observable.__tostring = util.constant('Observable')
  80. --- Creates a new Observable.
  81. -- @arg {function} subscribe - The subscription function that produces values.
  82. -- @returns {Observable}
  83. function Observable.create(subscribe)
  84. local self = {
  85. _subscribe = subscribe
  86. }
  87. return setmetatable(self, Observable)
  88. end
  89. --- Shorthand for creating an Observer and passing it to this Observable's subscription function.
  90. -- @arg {function} onNext - Called when the Observable produces a value.
  91. -- @arg {function} onError - Called when the Observable terminates due to an error.
  92. -- @arg {function} onCompleted - Called when the Observable completes normally.
  93. function Observable:subscribe(onNext, onError, onCompleted)
  94. if type(onNext) == 'table' then
  95. return self._subscribe(onNext)
  96. else
  97. return self._subscribe(Observer.create(onNext, onError, onCompleted))
  98. end
  99. end
  100. --- Returns an Observable that immediately completes without producing a value.
  101. function Observable.empty()
  102. return Observable.create(function(observer)
  103. observer:onCompleted()
  104. end)
  105. end
  106. --- Returns an Observable that never produces values and never completes.
  107. function Observable.never()
  108. return Observable.create(function(observer) end)
  109. end
  110. --- Returns an Observable that immediately produces an error.
  111. function Observable.throw(message)
  112. return Observable.create(function(observer)
  113. observer:onError(message)
  114. end)
  115. end
  116. --- Creates an Observable that produces a single value.
  117. -- @arg {*} value
  118. -- @returns {Observable}
  119. function Observable.fromValue(value)
  120. return Observable.create(function(observer)
  121. observer:onNext(value)
  122. observer:onCompleted()
  123. end)
  124. end
  125. --- Creates an Observable that produces a range of values in a manner similar to a Lua for loop.
  126. -- @arg {number} initial - The first value of the range, or the upper limit if no other arguments
  127. -- are specified.
  128. -- @arg {number=} limit - The second value of the range.
  129. -- @arg {number=1} step - An amount to increment the value by each iteration.
  130. -- @returns {Observable}
  131. function Observable.fromRange(initial, limit, step)
  132. if not limit and not step then
  133. initial, limit = 1, initial
  134. end
  135. step = step or 1
  136. return Observable.create(function(observer)
  137. for i = initial, limit, step do
  138. observer:onNext(i)
  139. end
  140. observer:onCompleted()
  141. end)
  142. end
  143. --- Creates an Observable that produces values from a table.
  144. -- @arg {table} table - The table used to create the Observable.
  145. -- @arg {function=pairs} iterator - An iterator used to iterate the table, e.g. pairs or ipairs.
  146. -- @arg {boolean} keys - Whether or not to also emit the keys of the table.
  147. -- @returns {Observable}
  148. function Observable.fromTable(t, iterator, keys)
  149. iterator = iterator or pairs
  150. return Observable.create(function(observer)
  151. for key, value in iterator(t) do
  152. observer:onNext(value, keys and key or nil)
  153. end
  154. observer:onCompleted()
  155. end)
  156. end
  157. --- Creates an Observable that produces values when the specified coroutine yields.
  158. -- @arg {thread} coroutine
  159. -- @returns {Observable}
  160. function Observable.fromCoroutine(thread, scheduler)
  161. thread = type(thread) == 'function' and coroutine.create(thread) or thread
  162. return Observable.create(function(observer)
  163. return scheduler:schedule(function()
  164. while not observer.stopped do
  165. local success, value = coroutine.resume(thread)
  166. if success then
  167. observer:onNext(value)
  168. else
  169. return observer:onError(value)
  170. end
  171. if coroutine.status(thread) == 'dead' then
  172. return observer:onCompleted()
  173. end
  174. coroutine.yield()
  175. end
  176. end)
  177. end)
  178. end
  179. --- Creates an Observable that creates a new Observable for each observer using a factory function.
  180. -- @arg {function} factory - A function that returns an Observable.
  181. -- @returns {Observable}
  182. function Observable.defer(fn)
  183. return setmetatable({
  184. subscribe = function(_, ...)
  185. local observable = fn()
  186. return observable:subscribe(...)
  187. end
  188. }, Observable)
  189. end
  190. --- Returns an Observable that repeats a value a specified number of times.
  191. -- @arg {*} value - The value to repeat.
  192. -- @arg {number=} count - The number of times to repeat the value. If left unspecified, the value
  193. -- is repeated an infinite number of times.
  194. -- @returns {Observable}
  195. function Observable.replicate(value, count)
  196. return Observable.create(function(observer)
  197. while count == nil or count > 0 do
  198. observer:onNext(value)
  199. if count then
  200. count = count - 1
  201. end
  202. end
  203. observer:onCompleted()
  204. end)
  205. end
  206. --- Subscribes to this Observable and prints values it produces.
  207. -- @arg {string=} name - Prefixes the printed messages with a name.
  208. -- @arg {function=tostring} formatter - A function that formats one or more values to be printed.
  209. function Observable:dump(name, formatter)
  210. name = name and (name .. ' ') or ''
  211. formatter = formatter or tostring
  212. local onNext = function(...) print(name .. 'onNext: ' .. formatter(...)) end
  213. local onError = function(e) print(name .. 'onError: ' .. e) end
  214. local onCompleted = function() print(name .. 'onCompleted') end
  215. return self:subscribe(onNext, onError, onCompleted)
  216. end
  217. --- Determine whether all items emitted by an Observable meet some criteria.
  218. -- @arg {function=identity} predicate - The predicate used to evaluate objects.
  219. function Observable:all(predicate)
  220. predicate = predicate or util.identity
  221. return Observable.create(function(observer)
  222. local function onNext(...)
  223. if not predicate(...) then
  224. observer:onNext(false)
  225. observer:onCompleted()
  226. end
  227. end
  228. local function onError(e)
  229. return observer:onError(e)
  230. end
  231. local function onCompleted()
  232. observer:onNext(true)
  233. return observer:onCompleted()
  234. end
  235. return self:subscribe(onNext, onError, onCompleted)
  236. end)
  237. end
  238. --- Given a set of Observables, produces values from only the first one to produce a value.
  239. -- @arg {Observable...} observables
  240. -- @returns {Observable}
  241. function Observable.amb(a, b, ...)
  242. if not a or not b then return a end
  243. return Observable.create(function(observer)
  244. local subscriptionA, subscriptionB
  245. local function onNextA(...)
  246. if subscriptionB then subscriptionB:unsubscribe() end
  247. observer:onNext(...)
  248. end
  249. local function onErrorA(e)
  250. if subscriptionB then subscriptionB:unsubscribe() end
  251. observer:onError(e)
  252. end
  253. local function onCompletedA()
  254. if subscriptionB then subscriptionB:unsubscribe() end
  255. observer:onCompleted()
  256. end
  257. local function onNextB(...)
  258. if subscriptionA then subscriptionA:unsubscribe() end
  259. observer:onNext(...)
  260. end
  261. local function onErrorB(e)
  262. if subscriptionA then subscriptionA:unsubscribe() end
  263. observer:onError(e)
  264. end
  265. local function onCompletedB()
  266. if subscriptionA then subscriptionA:unsubscribe() end
  267. observer:onCompleted()
  268. end
  269. subscriptionA = a:subscribe(onNextA, onErrorA, onCompletedA)
  270. subscriptionB = b:subscribe(onNextB, onErrorB, onCompletedB)
  271. return Subscription.create(function()
  272. subscriptionA:unsubscribe()
  273. subscriptionB:unsubscribe()
  274. end)
  275. end):amb(...)
  276. end
  277. --- Returns an Observable that produces the average of all values produced by the original.
  278. -- @returns {Observable}
  279. function Observable:average()
  280. return Observable.create(function(observer)
  281. local sum, count = 0, 0
  282. local function onNext(value)
  283. sum = sum + value
  284. count = count + 1
  285. end
  286. local function onError(e)
  287. observer:onError(e)
  288. end
  289. local function onCompleted()
  290. if count > 0 then
  291. observer:onNext(sum / count)
  292. end
  293. observer:onCompleted()
  294. end
  295. return self:subscribe(onNext, onError, onCompleted)
  296. end)
  297. end
  298. --- Returns an Observable that buffers values from the original and produces them as multiple
  299. -- values.
  300. -- @arg {number} size - The size of the buffer.
  301. function Observable:buffer(size)
  302. return Observable.create(function(observer)
  303. local buffer = {}
  304. local function emit()
  305. if #buffer > 0 then
  306. observer:onNext(util.unpack(buffer))
  307. buffer = {}
  308. end
  309. end
  310. local function onNext(...)
  311. local values = {...}
  312. for i = 1, #values do
  313. table.insert(buffer, values[i])
  314. if #buffer >= size then
  315. emit()
  316. end
  317. end
  318. end
  319. local function onError(message)
  320. emit()
  321. return observer:onError(message)
  322. end
  323. local function onCompleted()
  324. emit()
  325. return observer:onCompleted()
  326. end
  327. return self:subscribe(onNext, onError, onCompleted)
  328. end)
  329. end
  330. --- Returns an Observable that intercepts any errors from the previous and replace them with values
  331. -- produced by a new Observable.
  332. -- @arg {function|Observable} handler - An Observable or a function that returns an Observable to
  333. -- replace the source Observable in the event of an error.
  334. -- @returns {Observable}
  335. function Observable:catch(handler)
  336. handler = handler and (type(handler) == 'function' and handler or util.constant(handler))
  337. return Observable.create(function(observer)
  338. local subscription
  339. local function onNext(...)
  340. return observer:onNext(...)
  341. end
  342. local function onError(e)
  343. if not handler then
  344. return observer:onCompleted()
  345. end
  346. local continue = handler(e)
  347. if continue then
  348. if subscription then subscription:unsubscribe() end
  349. continue:subscribe(observer)
  350. else
  351. observer:onError(e)
  352. end
  353. end
  354. local function onCompleted()
  355. observer:onCompleted()
  356. end
  357. subscription = self:subscribe(onNext, onError, onCompleted)
  358. return subscription
  359. end)
  360. end
  361. --- Returns a new Observable that runs a combinator function on the most recent values from a set
  362. -- of Observables whenever any of them produce a new value. The results of the combinator function
  363. -- are produced by the new Observable.
  364. -- @arg {Observable...} observables - One or more Observables to combine.
  365. -- @arg {function} combinator - A function that combines the latest result from each Observable and
  366. -- returns a single value.
  367. -- @returns {Observable}
  368. function Observable:combineLatest(...)
  369. local sources = {...}
  370. local combinator = table.remove(sources)
  371. if type(combinator) ~= 'function' then
  372. table.insert(sources, combinator)
  373. combinator = function(...) return ... end
  374. end
  375. table.insert(sources, 1, self)
  376. return Observable.create(function(observer)
  377. local latest = {}
  378. local pending = {util.unpack(sources)}
  379. local completed = {}
  380. local function onNext(i)
  381. return function(value)
  382. latest[i] = value
  383. pending[i] = nil
  384. if not next(pending) then
  385. observer:onNext(combinator(util.unpack(latest)))
  386. end
  387. end
  388. end
  389. local function onError(e)
  390. return observer:onError(e)
  391. end
  392. local function onCompleted(i)
  393. return function()
  394. table.insert(completed, i)
  395. if #completed == #sources then
  396. observer:onCompleted()
  397. end
  398. end
  399. end
  400. for i = 1, #sources do
  401. sources[i]:subscribe(onNext(i), onError, onCompleted(i))
  402. end
  403. end)
  404. end
  405. --- Returns a new Observable that produces the values of the first with falsy values removed.
  406. -- @returns {Observable}
  407. function Observable:compact()
  408. return self:filter(util.identity)
  409. end
  410. --- Returns a new Observable that produces the values produced by all the specified Observables in
  411. -- the order they are specified.
  412. -- @arg {Observable...} sources - The Observables to concatenate.
  413. -- @returns {Observable}
  414. function Observable:concat(other, ...)
  415. if not other then return self end
  416. local others = {...}
  417. return Observable.create(function(observer)
  418. local function onNext(...)
  419. return observer:onNext(...)
  420. end
  421. local function onError(message)
  422. return observer:onError(message)
  423. end
  424. local function onCompleted()
  425. return observer:onCompleted()
  426. end
  427. local function chain()
  428. return other:concat(util.unpack(others)):subscribe(onNext, onError, onCompleted)
  429. end
  430. return self:subscribe(onNext, onError, chain)
  431. end)
  432. end
  433. --- Returns a new Observable that produces a single boolean value representing whether or not the
  434. -- specified value was produced by the original.
  435. -- @arg {*} value - The value to search for. == is used for equality testing.
  436. -- @returns {Observable}
  437. function Observable:contains(value)
  438. return Observable.create(function(observer)
  439. local subscription
  440. local function onNext(...)
  441. local args = util.pack(...)
  442. if #args == 0 and value == nil then
  443. observer:onNext(true)
  444. if subscription then subscription:unsubscribe() end
  445. return observer:onCompleted()
  446. end
  447. for i = 1, #args do
  448. if args[i] == value then
  449. observer:onNext(true)
  450. if subscription then subscription:unsubscribe() end
  451. return observer:onCompleted()
  452. end
  453. end
  454. end
  455. local function onError(e)
  456. return observer:onError(e)
  457. end
  458. local function onCompleted()
  459. observer:onNext(false)
  460. return observer:onCompleted()
  461. end
  462. subscription = self:subscribe(onNext, onError, onCompleted)
  463. return subscription
  464. end)
  465. end
  466. --- Returns an Observable that produces a single value representing the number of values produced
  467. -- by the source value that satisfy an optional predicate.
  468. -- @arg {function=} predicate - The predicate used to match values.
  469. function Observable:count(predicate)
  470. predicate = predicate or util.constant(true)
  471. return Observable.create(function(observer)
  472. local count = 0
  473. local function onNext(...)
  474. if predicate(...) then
  475. count = count + 1
  476. end
  477. end
  478. local function onError(e)
  479. return observer:onError(e)
  480. end
  481. local function onCompleted()
  482. observer:onNext(count)
  483. observer:onCompleted()
  484. end
  485. return self:subscribe(onNext, onError, onCompleted)
  486. end)
  487. end
  488. --- Returns a new Observable that produces a default set of items if the source Observable produces
  489. -- no values.
  490. -- @arg {*...} values - Zero or more values to produce if the source completes without emitting
  491. -- anything.
  492. -- @returns {Observable}
  493. function Observable:defaultIfEmpty(...)
  494. local defaults = util.pack(...)
  495. return Observable.create(function(observer)
  496. local hasValue = false
  497. local function onNext(...)
  498. hasValue = true
  499. observer:onNext(...)
  500. end
  501. local function onError(e)
  502. observer:onError(e)
  503. end
  504. local function onCompleted()
  505. if not hasValue then
  506. observer:onNext(util.unpack(defaults))
  507. end
  508. observer:onCompleted()
  509. end
  510. return self:subscribe(onNext, onError, onCompleted)
  511. end)
  512. end
  513. --- Returns a new Observable that produces the values from the original with duplicates removed.
  514. -- @returns {Observable}
  515. function Observable:distinct()
  516. return Observable.create(function(observer)
  517. local values = {}
  518. local function onNext(x)
  519. if not values[x] then
  520. observer:onNext(x)
  521. end
  522. values[x] = true
  523. end
  524. local function onError(e)
  525. return observer:onError(e)
  526. end
  527. local function onCompleted()
  528. return observer:onCompleted()
  529. end
  530. return self:subscribe(onNext, onError, onCompleted)
  531. end)
  532. end
  533. --- Returns an Observable that only produces values from the original if they are different from
  534. -- the previous value.
  535. -- @arg {function} comparator - A function used to compare 2 values. If unspecified, == is used.
  536. -- @returns {Observable}
  537. function Observable:distinctUntilChanged(comparator)
  538. comparator = comparator or util.eq
  539. return Observable.create(function(observer)
  540. local first = true
  541. local currentValue = nil
  542. local function onNext(value, ...)
  543. if first or not comparator(value, currentValue) then
  544. observer:onNext(value, ...)
  545. currentValue = value
  546. first = false
  547. end
  548. end
  549. local function onError(message)
  550. return observer:onError(message)
  551. end
  552. local function onCompleted()
  553. return observer:onCompleted()
  554. end
  555. return self:subscribe(onNext, onError, onCompleted)
  556. end)
  557. end
  558. --- Returns an Observable that produces the nth element produced by the source Observable.
  559. -- @arg {number} index - The index of the item, with an index of 1 representing the first.
  560. -- @returns {Observable}
  561. function Observable:elementAt(index)
  562. return Observable.create(function(observer)
  563. local subscription
  564. local i = 1
  565. local function onNext(...)
  566. if i == index then
  567. observer:onNext(...)
  568. observer:onCompleted()
  569. if subscription then
  570. subscription:unsubscribe()
  571. end
  572. else
  573. i = i + 1
  574. end
  575. end
  576. local function onError(e)
  577. return observer:onError(e)
  578. end
  579. local function onCompleted()
  580. return observer:onCompleted()
  581. end
  582. subscription = self:subscribe(onNext, onError, onCompleted)
  583. return subscription
  584. end)
  585. end
  586. --- Returns a new Observable that only produces values of the first that satisfy a predicate.
  587. -- @arg {function} predicate - The predicate used to filter values.
  588. -- @returns {Observable}
  589. function Observable:filter(predicate)
  590. predicate = predicate or util.identity
  591. return Observable.create(function(observer)
  592. local function onNext(...)
  593. if predicate(...) then
  594. return observer:onNext(...)
  595. end
  596. end
  597. local function onError(e)
  598. return observer:onError(e)
  599. end
  600. local function onCompleted()
  601. return observer:onCompleted()
  602. end
  603. return self:subscribe(onNext, onError, onCompleted)
  604. end)
  605. end
  606. --- Returns a new Observable that produces the first value of the original that satisfies a
  607. -- predicate.
  608. -- @arg {function} predicate - The predicate used to find a value.
  609. function Observable:find(predicate)
  610. predicate = predicate or util.identity
  611. return Observable.create(function(observer)
  612. local function onNext(...)
  613. if predicate(...) then
  614. observer:onNext(...)
  615. return observer:onCompleted()
  616. end
  617. end
  618. local function onError(message)
  619. return observer:onError(message)
  620. end
  621. local function onCompleted()
  622. return observer:onCompleted()
  623. end
  624. return self:subscribe(onNext, onError, onCompleted)
  625. end)
  626. end
  627. --- Returns a new Observable that only produces the first result of the original.
  628. -- @returns {Observable}
  629. function Observable:first()
  630. return self:take(1)
  631. end
  632. --- Returns a new Observable that transform the items emitted by an Observable into Observables,
  633. -- then flatten the emissions from those into a single Observable
  634. -- @arg {function} callback - The function to transform values from the original Observable.
  635. -- @returns {Observable}
  636. function Observable:flatMap(callback)
  637. callback = callback or util.identity
  638. return self:map(callback):flatten()
  639. end
  640. --- Returns a new Observable that uses a callback to create Observables from the values produced by
  641. -- the source, then produces values from the most recent of these Observables.
  642. -- @arg {function=identity} callback - The function used to convert values to Observables.
  643. -- @returns {Observable}
  644. function Observable:flatMapLatest(callback)
  645. callback = callback or util.identity
  646. return Observable.create(function(observer)
  647. local innerSubscription
  648. local function onNext(...)
  649. observer:onNext(...)
  650. end
  651. local function onError(e)
  652. return observer:onError(e)
  653. end
  654. local function onCompleted()
  655. return observer:onCompleted()
  656. end
  657. local function subscribeInner(...)
  658. if innerSubscription then
  659. innerSubscription:unsubscribe()
  660. end
  661. innerSubscription = callback(...):subscribe(onNext, onError)
  662. end
  663. local subscription = self:subscribe(subscribeInner, onError, onCompleted)
  664. return Subscription.create(function()
  665. if innerSubscription then
  666. innerSubscription:unsubscribe()
  667. end
  668. if subscription then
  669. subscription:unsubscribe()
  670. end
  671. end)
  672. end)
  673. end
  674. --- Returns a new Observable that subscribes to the Observables produced by the original and
  675. -- produces their values.
  676. -- @returns {Observable}
  677. function Observable:flatten()
  678. return Observable.create(function(observer)
  679. local function onError(message)
  680. return observer:onError(message)
  681. end
  682. local function onNext(observable)
  683. local function innerOnNext(...)
  684. observer:onNext(...)
  685. end
  686. observable:subscribe(innerOnNext, onError, util.noop)
  687. end
  688. local function onCompleted()
  689. return observer:onCompleted()
  690. end
  691. return self:subscribe(onNext, onError, onCompleted)
  692. end)
  693. end
  694. --- Returns an Observable that terminates when the source terminates but does not produce any
  695. -- elements.
  696. -- @returns {Observable}
  697. function Observable:ignoreElements()
  698. return Observable.create(function(observer)
  699. local function onError(message)
  700. return observer:onError(message)
  701. end
  702. local function onCompleted()
  703. return observer:onCompleted()
  704. end
  705. return self:subscribe(nil, onError, onCompleted)
  706. end)
  707. end
  708. --- Returns a new Observable that only produces the last result of the original.
  709. -- @returns {Observable}
  710. function Observable:last()
  711. return Observable.create(function(observer)
  712. local value
  713. local empty = true
  714. local function onNext(...)
  715. value = {...}
  716. empty = false
  717. end
  718. local function onError(e)
  719. return observer:onError(e)
  720. end
  721. local function onCompleted()
  722. if not empty then
  723. observer:onNext(util.unpack(value or {}))
  724. end
  725. return observer:onCompleted()
  726. end
  727. return self:subscribe(onNext, onError, onCompleted)
  728. end)
  729. end
  730. --- Returns a new Observable that produces the values of the original transformed by a function.
  731. -- @arg {function} callback - The function to transform values from the original Observable.
  732. -- @returns {Observable}
  733. function Observable:map(callback)
  734. return Observable.create(function(observer)
  735. callback = callback or util.identity
  736. local function onNext(...)
  737. return observer:onNext(callback(...))
  738. end
  739. local function onError(e)
  740. return observer:onError(e)
  741. end
  742. local function onCompleted()
  743. return observer:onCompleted()
  744. end
  745. return self:subscribe(onNext, onError, onCompleted)
  746. end)
  747. end
  748. --- Returns a new Observable that produces the maximum value produced by the original.
  749. -- @returns {Observable}
  750. function Observable:max()
  751. return self:reduce(math.max)
  752. end
  753. --- Returns a new Observable that produces the values produced by all the specified Observables in
  754. -- the order they are produced.
  755. -- @arg {Observable...} sources - One or more Observables to merge.
  756. -- @returns {Observable}
  757. function Observable:merge(...)
  758. local sources = {...}
  759. table.insert(sources, 1, self)
  760. return Observable.create(function(observer)
  761. local function onNext(...)
  762. return observer:onNext(...)
  763. end
  764. local function onError(message)
  765. return observer:onError(message)
  766. end
  767. local function onCompleted(i)
  768. return function()
  769. sources[i] = nil
  770. if not next(sources) then
  771. observer:onCompleted()
  772. end
  773. end
  774. end
  775. for i = 1, #sources do
  776. sources[i]:subscribe(onNext, onError, onCompleted(i))
  777. end
  778. end)
  779. end
  780. --- Returns a new Observable that produces the minimum value produced by the original.
  781. -- @returns {Observable}
  782. function Observable:min()
  783. return self:reduce(math.min)
  784. end
  785. --- Returns an Observable that produces the values of the original inside tables.
  786. -- @returns {Observable}
  787. function Observable:pack()
  788. return self:map(util.pack)
  789. end
  790. --- Returns two Observables: one that produces values for which the predicate returns truthy for,
  791. -- and another that produces values for which the predicate returns falsy.
  792. -- @arg {function} predicate - The predicate used to partition the values.
  793. -- @returns {Observable}
  794. -- @returns {Observable}
  795. function Observable:partition(predicate)
  796. return self:filter(predicate), self:reject(predicate)
  797. end
  798. --- Returns a new Observable that produces values computed by extracting the given keys from the
  799. -- tables produced by the original.
  800. -- @arg {string...} keys - The key to extract from the table. Multiple keys can be specified to
  801. -- recursively pluck values from nested tables.
  802. -- @returns {Observable}
  803. function Observable:pluck(key, ...)
  804. if not key then return self end
  805. return Observable.create(function(observer)
  806. local function onNext(t)
  807. return observer:onNext(t[key])
  808. end
  809. local function onError(e)
  810. return observer:onError(e)
  811. end
  812. local function onCompleted()
  813. return observer:onCompleted()
  814. end
  815. return self:subscribe(onNext, onError, onCompleted)
  816. end):pluck(...)
  817. end
  818. --- Returns a new Observable that produces a single value computed by accumulating the results of
  819. -- running a function on each value produced by the original Observable.
  820. -- @arg {function} accumulator - Accumulates the values of the original Observable. Will be passed
  821. -- the return value of the last call as the first argument and the
  822. -- current values as the rest of the arguments.
  823. -- @arg {*} seed - A value to pass to the accumulator the first time it is run.
  824. -- @returns {Observable}
  825. function Observable:reduce(accumulator, seed)
  826. return Observable.create(function(observer)
  827. local result = seed
  828. local first = true
  829. local function onNext(...)
  830. if first and seed == nil then
  831. result = ...
  832. first = false
  833. else
  834. result = accumulator(result, ...)
  835. end
  836. end
  837. local function onError(e)
  838. return observer:onError(e)
  839. end
  840. local function onCompleted()
  841. observer:onNext(result)
  842. return observer:onCompleted()
  843. end
  844. return self:subscribe(onNext, onError, onCompleted)
  845. end)
  846. end
  847. --- Returns a new Observable that produces values from the original which do not satisfy a
  848. -- predicate.
  849. -- @arg {function} predicate - The predicate used to reject values.
  850. -- @returns {Observable}
  851. function Observable:reject(predicate)
  852. predicate = predicate or util.identity
  853. return Observable.create(function(observer)
  854. local function onNext(...)
  855. if not predicate(...) then
  856. return observer:onNext(...)
  857. end
  858. end
  859. local function onError(e)
  860. return observer:onError(e)
  861. end
  862. local function onCompleted()
  863. return observer:onCompleted()
  864. end
  865. return self:subscribe(onNext, onError, onCompleted)
  866. end)
  867. end
  868. --- Returns an Observable that restarts in the event of an error.
  869. -- @arg {number=} count - The maximum number of times to retry. If left unspecified, an infinite
  870. -- number of retries will be attempted.
  871. -- @returns {Observable}
  872. function Observable:retry(count)
  873. return Observable.create(function(observer)
  874. local subscription
  875. local retries = 0
  876. local function onNext(...)
  877. return observer:onNext(...)
  878. end
  879. local function onCompleted()
  880. return observer:onCompleted()
  881. end
  882. local function onError(message)
  883. if subscription then
  884. subscription:unsubscribe()
  885. end
  886. retries = retries + 1
  887. if count and retries > count then
  888. return observer:onError(message)
  889. end
  890. subscription = self:subscribe(onNext, onError, onCompleted)
  891. end
  892. return self:subscribe(onNext, onError, onCompleted)
  893. end)
  894. end
  895. --- Returns a new Observable that produces values computed by accumulating the results of running a
  896. -- function on each value produced by the original Observable.
  897. -- @arg {function} accumulator - Accumulates the values of the original Observable. Will be passed
  898. -- the return value of the last call as the first argument and the
  899. -- current values as the rest of the arguments. Each value returned
  900. -- from this function will be emitted by the Observable.
  901. -- @arg {*} seed - A value to pass to the accumulator the first time it is run.
  902. -- @returns {Observable}
  903. function Observable:scan(accumulator, seed)
  904. return Observable.create(function(observer)
  905. local result = seed
  906. local first = true
  907. local function onNext(...)
  908. if first and seed == nil then
  909. result = ...
  910. first = false
  911. else
  912. result = accumulator(result, ...)
  913. observer:onNext(result)
  914. end
  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)
  924. end
  925. --- Returns a new Observable that skips over a specified number of values produced by the original
  926. -- and produces the rest.
  927. -- @arg {number=1} n - The number of values to ignore.
  928. -- @returns {Observable}
  929. function Observable:skip(n)
  930. n = n or 1
  931. return Observable.create(function(observer)
  932. local i = 1
  933. local function onNext(...)
  934. if i > n then
  935. observer:onNext(...)
  936. else
  937. i = i + 1
  938. end
  939. end
  940. local function onError(e)
  941. return observer:onError(e)
  942. end
  943. local function onCompleted()
  944. return observer:onCompleted()
  945. end
  946. return self:subscribe(onNext, onError, onCompleted)
  947. end)
  948. end
  949. --- Returns a new Observable that skips over values produced by the original until the specified
  950. -- Observable produces a value.
  951. -- @arg {Observable} other - The Observable that triggers the production of values.
  952. -- @returns {Observable}
  953. function Observable:skipUntil(other)
  954. return Observable.create(function(observer)
  955. local triggered = false
  956. local function trigger()
  957. triggered = true
  958. end
  959. other:subscribe(trigger, trigger, trigger)
  960. local function onNext(...)
  961. if triggered then
  962. observer:onNext(...)
  963. end
  964. end
  965. local function onError()
  966. if triggered then
  967. observer:onError()
  968. end
  969. end
  970. local function onCompleted()
  971. if triggered then
  972. observer:onCompleted()
  973. end
  974. end
  975. return self:subscribe(onNext, onError, onCompleted)
  976. end)
  977. end
  978. --- Returns a new Observable that skips elements until the predicate returns falsy for one of them.
  979. -- @arg {function} predicate - The predicate used to continue skipping values.
  980. -- @returns {Observable}
  981. function Observable:skipWhile(predicate)
  982. predicate = predicate or util.identity
  983. return Observable.create(function(observer)
  984. local skipping = true
  985. local function onNext(...)
  986. if skipping then
  987. skipping = predicate(...)
  988. end
  989. if not skipping then
  990. return observer:onNext(...)
  991. end
  992. end
  993. local function onError(message)
  994. return observer:onError(message)
  995. end
  996. local function onCompleted()
  997. return observer:onCompleted()
  998. end
  999. return self:subscribe(onNext, onError, onCompleted)
  1000. end)
  1001. end
  1002. --- Returns an Observable that omits a specified number of values from the end of the original
  1003. -- Observable.
  1004. -- @arg {number} count - The number of items to omit from the end.
  1005. -- @returns {Observable}
  1006. function Observable:skipLast(count)
  1007. local buffer = {}
  1008. return Observable.create(function(observer)
  1009. local function emit()
  1010. if #buffer > count and buffer[1] then
  1011. local values = table.remove(buffer, 1)
  1012. observer:onNext(util.unpack(values))
  1013. end
  1014. end
  1015. local function onNext(...)
  1016. emit()
  1017. table.insert(buffer, util.pack(...))
  1018. end
  1019. local function onError(message)
  1020. return observer:onError(message)
  1021. end
  1022. local function onCompleted()
  1023. emit()
  1024. return observer:onCompleted()
  1025. end
  1026. return self:subscribe(onNext, onError, onCompleted)
  1027. end)
  1028. end
  1029. --- Returns a new Observable that produces the specified values followed by all elements produced by
  1030. -- the source Observable.
  1031. -- @arg {*...} values - The values to produce before the Observable begins producing values
  1032. -- normally.
  1033. -- @returns {Observable}
  1034. function Observable:startWith(...)
  1035. local values = util.pack(...)
  1036. return Observable.create(function(observer)
  1037. observer:onNext(util.unpack(values))
  1038. return self:subscribe(observer)
  1039. end)
  1040. end
  1041. --- Returns an Observable that produces a single value representing the sum of the values produced
  1042. -- by the original.
  1043. -- @returns {Observable}
  1044. function Observable:sum()
  1045. return self:reduce(function(x, y) return x + y end, 0)
  1046. end
  1047. --- Returns a new Observable that only produces the first n results of the original.
  1048. -- @arg {number=1} n - The number of elements to produce before completing.
  1049. -- @returns {Observable}
  1050. function Observable:take(n)
  1051. n = n or 1
  1052. return Observable.create(function(observer)
  1053. if n <= 0 then
  1054. observer:onCompleted()
  1055. return
  1056. end
  1057. local i = 1
  1058. local function onNext(...)
  1059. observer:onNext(...)
  1060. i = i + 1
  1061. if i > n then
  1062. observer:onCompleted()
  1063. end
  1064. end
  1065. local function onError(e)
  1066. return observer:onError(e)
  1067. end
  1068. local function onCompleted()
  1069. return observer:onCompleted()
  1070. end
  1071. return self:subscribe(onNext, onError, onCompleted)
  1072. end)
  1073. end
  1074. --- Returns a new Observable that completes when the specified Observable fires.
  1075. -- @arg {Observable} other - The Observable that triggers completion of the original.
  1076. -- @returns {Observable}
  1077. function Observable:takeUntil(other)
  1078. return Observable.create(function(observer)
  1079. local function onNext(...)
  1080. return observer:onNext(...)
  1081. end
  1082. local function onError(e)
  1083. return observer:onError(e)
  1084. end
  1085. local function onCompleted()
  1086. return observer:onCompleted()
  1087. end
  1088. other:subscribe(onCompleted, onCompleted, onCompleted)
  1089. return self:subscribe(onNext, onError, onCompleted)
  1090. end)
  1091. end
  1092. --- Returns a new Observable that produces elements until the predicate returns falsy.
  1093. -- @arg {function} predicate - The predicate used to continue production of values.
  1094. -- @returns {Observable}
  1095. function Observable:takeWhile(predicate)
  1096. predicate = predicate or util.identity
  1097. return Observable.create(function(observer)
  1098. local taking = true
  1099. local function onNext(...)
  1100. if taking then
  1101. taking = predicate(...)
  1102. if taking then
  1103. return observer:onNext(...)
  1104. else
  1105. return observer:onCompleted()
  1106. end
  1107. end
  1108. end
  1109. local function onError(message)
  1110. return observer:onError(message)
  1111. end
  1112. local function onCompleted()
  1113. return observer:onCompleted()
  1114. end
  1115. return self:subscribe(onNext, onError, onCompleted)
  1116. end)
  1117. end
  1118. --- Runs a function each time this Observable has activity. Similar to subscribe but does not
  1119. -- create a subscription.
  1120. -- @arg {function=} onNext - Run when the Observable produces values.
  1121. -- @arg {function=} onError - Run when the Observable encounters a problem.
  1122. -- @arg {function=} onCompleted - Run when the Observable completes.
  1123. -- @returns {Observable}
  1124. function Observable:tap(_onNext, _onError, _onCompleted)
  1125. _onNext = _onNext or util.noop
  1126. _onError = _onError or util.noop
  1127. _onCompleted = _onCompleted or util.noop
  1128. return Observable.create(function(observer)
  1129. local function onNext(...)
  1130. _onNext(...)
  1131. return observer:onNext(...)
  1132. end
  1133. local function onError(message)
  1134. _onError(message)
  1135. return observer:onError(message)
  1136. end
  1137. local function onCompleted()
  1138. _onCompleted()
  1139. return observer:onCompleted()
  1140. end
  1141. return self:subscribe(onNext, onError, onCompleted)
  1142. end)
  1143. end
  1144. --- Returns an Observable that unpacks the tables produced by the original.
  1145. -- @returns {Observable}
  1146. function Observable:unpack()
  1147. return self:map(util.unpack)
  1148. end
  1149. --- Returns an Observable that takes any values produced by the original that consist of multiple
  1150. -- return values and produces each value individually.
  1151. -- @returns {Observable}
  1152. function Observable:unwrap()
  1153. return Observable.create(function(observer)
  1154. local function onNext(...)
  1155. local values = {...}
  1156. for i = 1, #values do
  1157. observer:onNext(values[i])
  1158. end
  1159. end
  1160. local function onError(message)
  1161. return observer:onError(message)
  1162. end
  1163. local function onCompleted()
  1164. return observer:onCompleted()
  1165. end
  1166. return self:subscribe(onNext, onError, onCompleted)
  1167. end)
  1168. end
  1169. --- Returns an Observable that produces a sliding window of the values produced by the original.
  1170. -- @arg {number} size - The size of the window. The returned observable will produce this number
  1171. -- of the most recent values as multiple arguments to onNext.
  1172. -- @returns {Observable}
  1173. function Observable:window(size)
  1174. return Observable.create(function(observer)
  1175. local window = {}
  1176. local function onNext(value)
  1177. table.insert(window, value)
  1178. if #window >= size then
  1179. observer:onNext(util.unpack(window))
  1180. table.remove(window, 1)
  1181. end
  1182. end
  1183. local function onError(message)
  1184. return observer:onError(message)
  1185. end
  1186. local function onCompleted()
  1187. return observer:onCompleted()
  1188. end
  1189. return self:subscribe(onNext, onError, onCompleted)
  1190. end)
  1191. end
  1192. --- Returns an Observable that produces values from the original along with the most recently
  1193. -- produced value from all other specified Observables. Note that only the first argument from each
  1194. -- source Observable is used.
  1195. -- @arg {Observable...} sources - The Observables to include the most recent values from.
  1196. -- @returns {Observable}
  1197. function Observable:with(...)
  1198. local sources = {...}
  1199. return Observable.create(function(observer)
  1200. local latest = setmetatable({}, {__len = util.constant(#sources)})
  1201. local function setLatest(i)
  1202. return function(value)
  1203. latest[i] = value
  1204. end
  1205. end
  1206. local function onNext(value)
  1207. return observer:onNext(value, util.unpack(latest))
  1208. end
  1209. local function onError(e)
  1210. return observer:onError(e)
  1211. end
  1212. local function onCompleted()
  1213. return observer:onCompleted()
  1214. end
  1215. for i = 1, #sources do
  1216. sources[i]:subscribe(setLatest(i), util.noop, util.noop)
  1217. end
  1218. return self:subscribe(onNext, onError, onCompleted)
  1219. end)
  1220. end
  1221. --- @class ImmediateScheduler
  1222. -- @description Schedules Observables by running all operations immediately.
  1223. local ImmediateScheduler = {}
  1224. ImmediateScheduler.__index = ImmediateScheduler
  1225. ImmediateScheduler.__tostring = util.constant('ImmediateScheduler')
  1226. --- Creates a new ImmediateScheduler.
  1227. -- @returns {ImmediateScheduler}
  1228. function ImmediateScheduler.create()
  1229. return setmetatable({}, ImmediateScheduler)
  1230. end
  1231. --- Schedules a function to be run on the scheduler. It is executed immediately.
  1232. -- @arg {function} action - The function to execute.
  1233. function ImmediateScheduler:schedule(action)
  1234. action()
  1235. end
  1236. --- @class CooperativeScheduler
  1237. -- @description Manages Observables using coroutines and a virtual clock that must be updated
  1238. -- manually.
  1239. local CooperativeScheduler = {}
  1240. CooperativeScheduler.__index = CooperativeScheduler
  1241. CooperativeScheduler.__tostring = util.constant('CooperativeScheduler')
  1242. --- Creates a new CooperativeScheduler.
  1243. -- @arg {number=0} currentTime - A time to start the scheduler at.
  1244. -- @returns {Scheduler.CooperativeScheduler}
  1245. function CooperativeScheduler.create(currentTime)
  1246. local self = {
  1247. tasks = {},
  1248. currentTime = currentTime or 0
  1249. }
  1250. return setmetatable(self, CooperativeScheduler)
  1251. end
  1252. --- Schedules a function to be run after an optional delay.
  1253. -- @arg {function} action - The function to execute. Will be converted into a coroutine. The
  1254. -- coroutine may yield execution back to the scheduler with an optional
  1255. -- number, which will put it to sleep for a time period.
  1256. -- @arg {number=0} delay - Delay execution of the action by a time period.
  1257. function CooperativeScheduler:schedule(action, delay)
  1258. local task = {
  1259. thread = coroutine.create(action),
  1260. due = self.currentTime + (delay or 0)
  1261. }
  1262. table.insert(self.tasks, task)
  1263. return Subscription.create(function()
  1264. return self:unschedule(task)
  1265. end)
  1266. end
  1267. function CooperativeScheduler:unschedule(task)
  1268. for i = 1, #self.tasks do
  1269. if self.tasks[i] == task then
  1270. table.remove(self.tasks, i)
  1271. end
  1272. end
  1273. end
  1274. --- Triggers an update of the CooperativeScheduler. The clock will be advanced and the scheduler
  1275. -- will run any coroutines that are due to be run.
  1276. -- @arg {number=0} delta - An amount of time to advance the clock by. It is common to pass in the
  1277. -- time in seconds or milliseconds elapsed since this function was last
  1278. -- called.
  1279. function CooperativeScheduler:update(delta)
  1280. self.currentTime = self.currentTime + (delta or 0)
  1281. for i = #self.tasks, 1, -1 do
  1282. local task = self.tasks[i]
  1283. if self.currentTime >= task.due then
  1284. local success, delay = coroutine.resume(task.thread)
  1285. if success then
  1286. task.due = math.max(task.due + (delay or 0), self.currentTime)
  1287. else
  1288. error(delay)
  1289. end
  1290. if coroutine.status(task.thread) == 'dead' then
  1291. table.remove(self.tasks, i)
  1292. end
  1293. end
  1294. end
  1295. end
  1296. --- Returns whether or not the CooperativeScheduler's queue is empty.
  1297. function CooperativeScheduler:isEmpty()
  1298. return not next(self.tasks)
  1299. end
  1300. --- @class Subject
  1301. -- @description Subjects function both as an Observer and as an Observable. Subjects inherit all
  1302. -- Observable functions, including subscribe. Values can also be pushed to the Subject, which will
  1303. -- be broadcasted to any subscribed Observers.
  1304. local Subject = setmetatable({}, Observable)
  1305. Subject.__index = Subject
  1306. Subject.__tostring = util.constant('Subject')
  1307. --- Creates a new Subject.
  1308. -- @returns {Subject}
  1309. function Subject.create()
  1310. local self = {
  1311. observers = {},
  1312. stopped = false
  1313. }
  1314. return setmetatable(self, Subject)
  1315. end
  1316. --- Creates a new Observer and attaches it to the Subject.
  1317. -- @arg {function|table} onNext|observer - A function called when the Subject produces a value or
  1318. -- an existing Observer to attach to the Subject.
  1319. -- @arg {function} onError - Called when the Subject terminates due to an error.
  1320. -- @arg {function} onCompleted - Called when the Subject completes normally.
  1321. function Subject:subscribe(onNext, onError, onCompleted)
  1322. local observer
  1323. if type(onNext) == 'table' then
  1324. observer = onNext
  1325. else
  1326. observer = Observer.create(onNext, onError, onCompleted)
  1327. end
  1328. table.insert(self.observers, observer)
  1329. return Subscription.create(function()
  1330. for i = 1, #self.observers do
  1331. if self.observers[i] == observer then
  1332. table.remove(self.observers, i)
  1333. return
  1334. end
  1335. end
  1336. end)
  1337. end
  1338. --- Pushes zero or more values to the Subject. They will be broadcasted to all Observers.
  1339. -- @arg {*...} values
  1340. function Subject:onNext(...)
  1341. if not self.stopped then
  1342. for i = 1, #self.observers do
  1343. self.observers[i]:onNext(...)
  1344. end
  1345. end
  1346. end
  1347. --- Signal to all Observers that an error has occurred.
  1348. -- @arg {string=} message - A string describing what went wrong.
  1349. function Subject:onError(message)
  1350. if not self.stopped then
  1351. for i = 1, #self.observers do
  1352. self.observers[i]:onError(message)
  1353. end
  1354. self.stopped = true
  1355. end
  1356. end
  1357. --- Signal to all Observers that the Subject will not produce any more values.
  1358. function Subject:onCompleted()
  1359. if not self.stopped then
  1360. for i = 1, #self.observers do
  1361. self.observers[i]:onCompleted()
  1362. end
  1363. self.stopped = true
  1364. end
  1365. end
  1366. Subject.__call = Subject.onNext
  1367. --- @class BehaviorSubject
  1368. -- @description A Subject that tracks its current value. Provides an accessor to retrieve the most
  1369. -- recent pushed value, and all subscribers immediately receive the latest value.
  1370. local BehaviorSubject = setmetatable({}, Subject)
  1371. BehaviorSubject.__index = BehaviorSubject
  1372. BehaviorSubject.__tostring = util.constant('BehaviorSubject')
  1373. --- Creates a new BehaviorSubject.
  1374. -- @arg {*...} value - The initial values.
  1375. -- @returns {Subject}
  1376. function BehaviorSubject.create(...)
  1377. local self = {
  1378. observers = {},
  1379. stopped = false
  1380. }
  1381. if select('#', ...) > 0 then
  1382. self.value = util.pack(...)
  1383. end
  1384. return setmetatable(self, BehaviorSubject)
  1385. end
  1386. --- Creates a new Observer and attaches it to the Subject. Immediately broadcasts the most recent
  1387. -- value to the Observer.
  1388. -- @arg {function} onNext - Called when the Subject produces a value.
  1389. -- @arg {function} onError - Called when the Subject terminates due to an error.
  1390. -- @arg {function} onCompleted - Called when the Subject completes normally.
  1391. function BehaviorSubject:subscribe(onNext, onError, onCompleted)
  1392. local observer = Observer.create(onNext, onError, onCompleted)
  1393. Subject.subscribe(self, observer)
  1394. if self.value then
  1395. observer:onNext(unpack(self.value))
  1396. end
  1397. end
  1398. --- Pushes zero or more values to the BehaviorSubject. They will be broadcasted to all Observers.
  1399. -- @arg {*...} values
  1400. function BehaviorSubject:onNext(...)
  1401. self.value = util.pack(...)
  1402. return Subject.onNext(self, ...)
  1403. end
  1404. --- Returns the last value emitted by the Subject, or the initial value passed to the constructor
  1405. -- if nothing has been emitted yet.
  1406. -- @returns {*...}
  1407. function BehaviorSubject:getValue()
  1408. return self.value and util.unpack(self.value)
  1409. end
  1410. Observable.wrap = Observable.buffer
  1411. Observable['repeat'] = Observable.replicate
  1412. return {
  1413. util = util,
  1414. Subscription = Subscription,
  1415. Observer = Observer,
  1416. Observable = Observable,
  1417. ImmediateScheduler = ImmediateScheduler,
  1418. CooperativeScheduler = CooperativeScheduler,
  1419. Subject = Subject,
  1420. BehaviorSubject = BehaviorSubject
  1421. }