aboutsummaryrefslogtreecommitdiff
path: root/stdlib/source/documentation/lux/control/io.lux
blob: 495f57023218d8381cf151c5b91ca2d59c752c79 (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
(.require
 [library
  [lux (.except if loop)
   ["$" documentation]
   [data
    [text (.only \n)
     ["%" \\format (.only format)]]]
   [macro
    ["[0]" template]]]]
 [\\library
  ["[0]" /]])

(.def .public documentation
  (.List $.Module)
  ($.module /._
            "A method for abstracting I/O and effectful computations to make it safe while writing pure functional code."
            [($.default /.functor)
             ($.default /.apply)
             ($.default /.monad)

             ($.documentation (/.IO it)
               "A type that represents synchronous, effectful computations that may interact with the outside world.")

             ($.documentation /.io
               (format "Delays the evaluation of an expression, by wrapping it in an IO 'thunk'."
                       \n "Great for wrapping effectful computations (which will not be performed until the IO is 'run!').")
               [(io (exec
                      (log! msg)
                      "Some value..."))])

             ($.documentation /.run!
               "A way to execute IO computations and perform their side-effects.")]
            []))