aboutsummaryrefslogtreecommitdiff
path: root/stdlib/source/documentation/lux/world/file/watch.lux
blob: b5c0f97e2332581d1263e81236458a7f7af9409d (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
... This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
... If a copy of the MPL was not distributed with this file, You can obtain one at https://mozilla.org/MPL/2.0/.

(.require
 [library
  [lux (.except)
   ["$" documentation]
   [data
    ["[0]" text (.only \n)
     ["%" \\format (.only format)]]]
   [meta
    ["@" target]]]]
 [\\library
  ["[0]" /]])

(def .public documentation
  (List $.Documentation)
  (`` (`` (list ($.module /._
                          "")

                ($.definition /.creation)
                ($.definition /.creation?)
                ($.definition /.modification)
                ($.definition /.modification?)
                ($.definition /.deletion)
                ($.definition /.deletion?)
                ($.definition /.all)
                ($.definition /.not_being_watched)
                ($.definition /.cannot_poll_a_non_existent_directory)
                
                ($.definition /.Concern
                  "A particular concern to watch-out for.")

                ($.definition /.and
                  ""
                  ($.example (and left right)))

                ($.definition (/.Watcher !)
                  "Machinery for watching a file-system for changes to files and directories.")

                ($.definition /.polling
                  (format "A simple watcher that works for any file-system."
                          "Polls files and directories to detect changes.")
                  ($.example (polling fs)))

                ($.definition /.mock
                  (format "A fake/emulated watcher."
                          \n "Must be given a path separator for the file-system.")
                  ($.example (mock separator)))

                (,, (for @.jvm (,, (these ($.definition /.default
                                            "The default watcher for the default file-system.")))
                         (,, (these))))
                ))))