aboutsummaryrefslogtreecommitdiff
path: root/stdlib/source/documentation/lux/data/collection/queue.lux
blob: 935b0dfc325533c3513dfd7786f61fcbdc65e9b4 (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
(.require
 [library
  [lux (.except list)
   ["$" documentation]]]
 [\\library
  ["[0]" /]]
 ["[0]" /
  ["[1][0]" priority]])

(.def .public documentation
  (.List $.Module)
  ($.module /._
            ""
            [($.default /.empty)
             ($.default /.size)
             ($.default /.empty?)
             ($.default /.equivalence)
             ($.default /.functor)

             ($.documentation (/.Queue it)
               "A first-in, first-out sequential data-structure.")

             ($.documentation /.of_list
               ""
               [(of_list entries)])

             ($.documentation /.list
               ""
               [(list queue)])

             ($.documentation /.front
               "Yields the first value in the queue, if any.")

             ($.documentation /.member?
               ""
               [(member? equivalence queue member)])

             ($.documentation /.next
               ""
               [(next queue)])

             ($.documentation /.end
               ""
               [(end val queue)])]
            [/priority.documentation]))