aboutsummaryrefslogtreecommitdiff
path: root/stdlib/source/documentation/lux/ffi.rb.lux
blob: adc573a441c35a570106f0653a31ee78cef2bc1f (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
... 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)]]]]]
 [\\library
  ["[0]" /]])

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

        ($.definition (/.Object brand))
        ($.definition /.Nil)
        ($.definition /.Function)
        ($.definition /.Integer)
        ($.definition /.Float)
        ($.definition /.String)

        ($.definition /.import
          "Easily import types, methods, functions and constants."
          ($.example (import Stat
                       "[1]::[0]"
                       (executable? [] Bit)
                       (size Int)))
          ($.example (import File "as" RubyFile
                       "[1]::[0]"
                       ("static" SEPARATOR ..String)
                       ("static" open [Path ..String] "io" "try" RubyFile)
                       ("static" stat [Path] "io" "try" Stat)
                       ("static" delete [Path] "io" "try" Int)
                       ("static" file? [Path] "io" "try" Bit)
                       ("static" directory? [Path] "io" "try" Bit)

                       (read [] "io" "try" Binary)
                       (write [Binary] "io" "try" Int)
                       (flush [] "io" "try" "?" Any)
                       (close [] "io" "try" "?" Any))))
        ))