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

(.def .public documentation
  (.List $.Module)
  ($.module /._
            ""
            [($.default /.monoid)
             ($.default /.functor)
             ($.default /.apply)
             ($.default /.monad)
             ($.default /.equivalence)
             ($.default /.hash)
             ($.default /.with)
             ($.default /.list)

             ($.definition /.lifted
               "Wraps a monadic value with Maybe machinery."
               [(lifted monad)])

             ($.definition /.else
               (format "Allows you to provide a default value that will be used"
                       \n "if a (Maybe x) value turns out to be .#None."
                       \n "Note: the expression for the default value will not be computed if the base computation succeeds.")
               [(else +20 {.#Some +10})
                "=>"
                +10]
               [(else +20 {.#None})
                "=>"
                +20])

             ($.definition /.trusted
               (format "Assumes that a Maybe value is a .#Some and yields its value."
                       \n "Raises/throws a runtime error otherwise."
                       \n "WARNING: Use with caution.")
               [(trusted trusted_computation)])

             ($.definition /.when
               "Can be used as a guard in (co)monadic be/do expressions."
               [(do monad
                  [value (do_something 1 2 3)
                   .when (passes_test? value)]
                  (do_something_else 4 5 6))])]
            []))