Difference between revisions of "X File"

From GiderosMobile
Line 3: Line 3:
 
'''Available since:''' Gideros 2011.6<br/>
 
'''Available since:''' Gideros 2011.6<br/>
 
=== Description ===
 
=== Description ===
<translate>file object is usually returned by [[io.open]] used to manipulate (read and write) files in lua</translate>
+
<translate>file object is usually returned by [[Special:MyLanguage/io.open|io.open]] used to manipulate (read and write) files in lua</translate>
 
=== Examples ===
 
=== Examples ===
 
'''Copy a file'''<br/>
 
'''Copy a file'''<br/>
Line 21: Line 21:
 
| style="width: 50%; vertical-align:top;"|
 
| style="width: 50%; vertical-align:top;"|
 
=== Methods ===
 
=== Methods ===
[[file:close]] ''<translate>closes file</translate>''<br/>
+
[[Special:MyLanguage/file:close|file:close]] ''<translate>closes file</translate>''<br/>
[[file:flush]] ''<translate>saves any written data to file</translate>''<br/>
+
[[Special:MyLanguage/file:flush|file:flush]] ''<translate>saves any written data to file</translate>''<br/>
[[file:lines]] ''<translate>returns iterator function to return lines, nil ends</translate>''<br/>
+
[[Special:MyLanguage/file:lines|file:lines]] ''<translate>returns iterator function to return lines, nil ends</translate>''<br/>
[[file:read]] ''<translate>reads file according to given formats, returns read values or nil</translate>''<br/>
+
[[Special:MyLanguage/file:read|file:read]] ''<translate>reads file according to given formats, returns read values or nil</translate>''<br/>
[[file:seek]] ''<translate>sets file pos, whence="set"|"cur"|"end", defaults "curr",0, returns file pos</translate>''<br/>
+
[[Special:MyLanguage/file:seek|file:seek]] ''<translate>sets file pos, whence="set"|"cur"|"end", defaults "curr",0, returns file pos</translate>''<br/>
[[file:write]] ''<translate>writes strings or numbers to file</translate>''<br/>
+
[[Special:MyLanguage/file:write|file:write]] ''<translate>writes strings or numbers to file</translate>''<br/>
 
| style="width: 50%; vertical-align:top;"|
 
| style="width: 50%; vertical-align:top;"|
 
=== Events ===
 
=== Events ===
 
=== Constants ===
 
=== Constants ===
 
|}
 
|}

Revision as of 17:34, 23 August 2018

Supported platforms: android, ios, mac, pc
Available since: Gideros 2011.6

Description

file object is usually returned by io.open used to manipulate (read and write) files in lua

Examples

Copy a file

local function copy(src, dst)
	local srcf = io.open(src, "rb")
	local dstf = io.open(dst, "wb")
	local size = 2^13      -- good buffer size (8K)
	while true do
		local block = srcf:read(size)
		if not block then break end
		dstf:write(block)
	end
	srcf:close()
	dstf:close()
end

Methods

file:close closes file
file:flush saves any written data to file
file:lines returns iterator function to return lines, nil ends
file:read reads file according to given formats, returns read values or nil
file:seek sets file pos, whence="set"|"cur"|"end", defaults "curr",0, returns file pos
file:write writes strings or numbers to file

Events

Constants