Difference between revisions of "X File"

From GiderosMobile
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 +
<!-- GIDEROSOBJ:file -->
 
'''<translate>Supported platforms</translate>:''' [[File:Platform android.png]][[File:Platform ios.png]][[File:Platform mac.png]][[File:Platform pc.png]]<br/>
 
'''<translate>Supported platforms</translate>:''' [[File:Platform android.png]][[File:Platform ios.png]][[File:Platform mac.png]][[File:Platform pc.png]]<br/>
 
'''<translate>Available since</translate>:''' Gideros 2011.6<br/>
 
'''<translate>Available since</translate>:''' Gideros 2011.6<br/>
Line 21: Line 22:
 
| style="width: 50%; vertical-align:top;"|
 
| style="width: 50%; vertical-align:top;"|
 
=== <translate>Methods</translate> ===
 
=== <translate>Methods</translate> ===
[[Special:MyLanguage/file:close|file:close]] ''<translate>closes file</translate>''<br/>
+
[[Special:MyLanguage/file:close|file:close]] ''<translate>closes file</translate>''<br/><!-- GIDEROSMTD:file:close -->
[[Special:MyLanguage/file:flush|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/><!-- GIDEROSMTD:file:flush -->
[[Special:MyLanguage/file:lines|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/><!-- GIDEROSMTD:file:lines -->
[[Special:MyLanguage/file:read|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/><!-- GIDEROSMTD:file:read -->
[[Special:MyLanguage/file:seek|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/><!-- GIDEROSMTD:file:seek -->
[[Special:MyLanguage/file:write|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/><!-- GIDEROSMTD:file:write -->
 
| style="width: 50%; vertical-align:top;"|
 
| style="width: 50%; vertical-align:top;"|
 
=== <translate>Events</translate> ===
 
=== <translate>Events</translate> ===
 
=== <translate>Constants</translate> ===
 
=== <translate>Constants</translate> ===
 
|}
 
|}

Revision as of 14:55, 31 August 2018

Supported platforms: Platform android.pngPlatform ios.pngPlatform mac.pngPlatform pc.png
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