aboutsummaryrefslogtreecommitdiff
path: root/stdlib/source/documentation/lux/control/reader.lux
blob: e6aa7c35d313c07229283facdf288308f787ed24 (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
(.module:
  [library
   [lux {"-" [local]}
    ["$" documentation {"+" [documentation:]}]
    [data
     [text {"+" [\n]}
      ["%" format {"+" [format]}]]]
    [macro
     ["." template]]]]
  [\\library
   ["." /]])

(documentation: (/.Reader environment it)
  "Computations that have access to some environmental value.")

(documentation: /.read
  "Get the environment.")

(documentation: /.local
  "Run computation with a locally-modified environment."
  [(local change proc)])

(documentation: /.result
  "Executes the reader against the given environment."
  [(result env proc)])

(documentation: /.with
  "Monad transformer for Reader."
  [(with monad)])

(documentation: /.lifted
  "Lift monadic values to the Reader wrapper.")

(.def: .public documentation
  (.List $.Module)
  ($.module /._
            ""
            [..Reader
             ..read
             ..local
             ..result
             ..with
             ..lifted
             ($.default /.functor)
             ($.default /.apply)
             ($.default /.monad)]
            []))