aboutsummaryrefslogtreecommitdiff
path: root/stdlib/source/documentation/lux/control/concurrency/frp.lux
blob: ed095f73c93a285bb259ad9480a1e0aa041922eb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
(.require
 [library
  [lux (.except if loop)
   ["$" documentation]
   [data
    [text (.only \n)
     ["%" \\format (.only format)]]]]]
 [\\library
  ["[0]" /]])

(.def .public documentation
  (.List $.Module)
  ($.module /._
            ""
            [($.default /.channel_is_already_closed)
             ($.default /.functor)
             ($.default /.apply)
             ($.default /.monad)
             ($.default /.subscribe!)
             ($.default /.mixes)
             ($.default /.poll)
             ($.default /.periodic)
             ($.default /.iterations)
             ($.default /.distinct)
             ($.default /.list)

             ($.definition (/.Channel it)
               "An asynchronous channel to distribute values.")

             ($.definition (/.Sink it)
               "The tail-end of a channel, which can be written-to to fee the channel.")

             ($.definition /.channel
               "Creates a brand-new channel and hands it over, along with the sink to write to it."
               [(channel _)])

             ($.definition (/.Subscriber it)
               "A function that can receive every value fed into a channel.")

             ($.definition /.only
               (format "Produces a new channel based on the old one, only with values"
                       \n "that pass the test.")
               [(only pass? channel)])

             ($.definition /.of_async
               "A one-element channel containing the output from an async."
               [(of_async async)])

             ($.definition /.mix
               "Asynchronous mix over channels."
               [(mix f init channel)])

             ($.definition /.sequential
               "Transforms the given list into a channel with the same elements."
               [(sequential milli_seconds values)])]
            []))