summaryrefslogtreecommitdiff
path: root/server/locale/en-US/libs/@lua/io.lni
blob: 2b405f2fdb220ae581295acf9df0c880a65a08c6 (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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
[stdin]
description = 'standard input.'

[stdout]
description = 'standard output.'

[stderr]
description = 'standard error.'

[close]
description = 'Close `file` or default output file.'

[flush]
description = 'Saves any written data to default output file.'

[input]
description = 'Sets `file` as the default input file.'

["lines Lua 5.1"]
description = [[
------
```lua
for c in io.lines(filename, ...) do
    body
end
```
]]
[[.enums]]
name = 'mode'
enum = '"*n"'
description = 'Reads a numeral and returns it as number.'
``````````
name = 'mode'
enum = '"*a"'
description = 'Reads the whole file.'
``````````
name = 'mode'
enum = '"*l"'
description = 'Reads the next line skipping the end of line.'
``````````
name = 'mode'
code = 'number'
description = 'Reads a string with up to this number of bytes.'

["lines Lua 5.3"]
description = [[
------
```lua
for c in io.lines(filename, ...) do
    body
end
```
]]
[[.enums]]
name = 'mode'
enum = '"n"'
description = 'Reads a numeral and returns it as number.'
``````````
name = 'mode'
enum = '"a"'
description = 'Reads the whole file.'
``````````
name = 'mode'
enum = '"l"'
description = 'Reads the next line skipping the end of line.'
``````````
name = 'mode'
enum = '"L"'
description = 'Reads the next line keeping the end of line.'
``````````
name = 'mode'
code = 'number'
description = 'Reads a string with up to this number of bytes.'

["lines LuaJIT"]
description = [[
------
```lua
for c in io.lines(filename, ...) do
    body
end
```
]]
[[.enums]]
name = 'mode'
enum = '"*n"'
description = 'Reads a numeral and returns it as number.'
``````````
name = 'mode'
enum = '"*a"'
description = 'Reads the whole file.'
``````````
name = 'mode'
enum = '"*l"'
description = 'Reads the next line skipping the end of line.'
``````````
name = 'mode'
enum = '"*L"'
description = 'Reads the next line keeping the end of line.'
``````````
name = 'mode'
code = 'number'
description = 'Reads a string with up to this number of bytes.'

[open]
description = 'Opens a file, in the mode specified in the string `mode`.'
[[.enums]]
name = 'mode'
enum = '"r"'
description = 'Read mode.'
``````````
name = 'mode'
enum = '"w"'
description = 'Write mode.'
``````````
name = 'mode'
enum = '"a"'
description = 'Append mode.'
``````````
name = 'mode'
enum = '"r+"'
description = 'Update mode, all previous data is preserved.'
``````````
name = 'mode'
enum = '"w+"'
description = 'Update mode, all previous data is erased.'
``````````
name = 'mode'
enum = '"a+"'
description = 'Append update mode, previous data is preserved, writing is only allowed at the end of file.'

[output]
description = 'Sets `file` as the default output file.'

[popen]
description = 'Starts program prog in a separated process.'
[[.enums]]
name = 'mode'
enum = '"r"'
description = 'Read data from this program by `file`.'
``````````
name = 'mode'
enum = '"w"'
description = 'Write data to this program by `file`.'

["read Lua 5.1"]
description = 'Reads the `file`, according to the given formats, which specify what to read.'
[[.enums]]
name = 'mode'
enum = '"*n"'
description = 'Reads a numeral and returns it as number.'
``````````
name = 'mode'
enum = '"*a"'
description = 'Reads the whole file.'
``````````
name = 'mode'
enum = '"*l"'
description = 'Reads the next line skipping the end of line.'
``````````
name = 'mode'
code = 'number'
description = 'Reads a string with up to this number of bytes.'

["read Lua 5.3"]
description = 'Reads the `file`, according to the given formats, which specify what to read.'
[[.enums]]
name = 'mode'
enum = '"n"'
description = 'Reads a numeral and returns it as number.'
``````````
name = 'mode'
enum = '"a"'
description = 'Reads the whole file.'
``````````
name = 'mode'
enum = '"l"'
description = 'Reads the next line skipping the end of line.'
``````````
name = 'mode'
enum = '"L"'
description = 'Reads the next line keeping the end of line.'
``````````
name = 'mode'
code = 'number'
description = 'Reads a string with up to this number of bytes.'

["read LuaJIT"]
description = 'Reads the `file`, according to the given formats, which specify what to read.'
[[.enums]]
name = 'mode'
enum = '"*n"'
description = 'Reads a numeral and returns it as number.'
``````````
name = 'mode'
enum = '"*a"'
description = 'Reads the whole file.'
``````````
name = 'mode'
enum = '"*l"'
description = 'Reads the next line skipping the end of line.'
``````````
name = 'mode'
enum = '"*L"'
description = 'Reads the next line keeping the end of line.'
``````````
name = 'mode'
code = 'number'
description = 'Reads a string with up to this number of bytes.'

[tmpfile]
description = 'In case of success, returns a handle for a temporary file.'

[type]
description = 'Checks whether `obj` is a valid file handle.'
[[.enums]]
name = 'type'
enum = '"file"'
description = 'Is an open file handle.'
``````````
name = 'type'
enum = '"closed file"'
description = 'Is a closed file handle.'
``````````
name = 'type'
code = 'nil'
description = 'Is not a file handle.'

[write]
description = 'Writes the value of each of its arguments to default output file.'