Difference between revisions of "X File"

From GiderosMobile
m (MoKaLux moved page File to X File: wiki reserved word)
(added x_ before file because file: is a wiki reserved word)
Line 23: Line 23:
 
| 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/><!-- GIDEROSMTD:file:close() closes file -->
+
[[Special:MyLanguage/x_file:close|file:close]] ''<translate>closes file</translate>''<br/>
[[Special:MyLanguage/file:flush|file:flush]] ''<translate>saves any written data to file</translate>''<br/><!-- GIDEROSMTD:file:flush() saves any written data to file -->
+
<!-- GIDEROSMTD:file:close() closes file -->
[[Special:MyLanguage/file:lines|file:lines]] ''<translate>returns iterator function to return lines, nil ends</translate>''<br/><!-- GIDEROSMTD:file:lines() returns iterator function to return lines, nil ends -->
+
[[Special:MyLanguage/x_file:flush|file:flush]] ''<translate>saves any written data to file</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(format1,...) reads file according to given formats, returns read values or nil -->
+
<!-- GIDEROSMTD:file:flush() saves any written data to file -->
[[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(whence,offset) sets file pos, whence="set"|"cur"|"end", defaults "curr",0, returns file pos -->
+
[[Special:MyLanguage/x_file:lines|file:lines]] ''<translate>returns iterator function to return lines, nil ends</translate>''<br/>
[[Special:MyLanguage/file:write|file:write]] ''<translate>writes strings or numbers to file</translate>''<br/><!-- GIDEROSMTD:file:write(value1,...) writes strings or numbers to file -->
+
<!-- GIDEROSMTD:file:lines() returns iterator function to return lines, nil ends -->
 +
[[Special:MyLanguage/x_file:read|file:read]] ''<translate>reads file according to given formats, returns read values or nil</translate>''<br/>
 +
<!-- GIDEROSMTD:file:read(format1,...) reads file according to given formats, returns read values or nil -->
 +
[[Special:MyLanguage/x_file:seek|file:seek]] ''<translate>sets file pos, whence="set"|"cur"|"end", defaults "curr",0, returns file pos</translate>''<br/>
 +
<!-- GIDEROSMTD:file:seek(whence,offset) sets file pos, whence="set"|"cur"|"end", defaults "curr",0, returns file pos -->
 +
[[Special:MyLanguage/x_file:write|file:write]] ''<translate>writes strings or numbers to file</translate>''<br/>
 +
<!-- GIDEROSMTD:file:write(value1,...) writes strings or numbers to file -->
 +
 
 
| style="width: 50%; vertical-align:top;"|
 
| style="width: 50%; vertical-align:top;"|
 
=== <translate>Events</translate> ===
 
=== <translate>Events</translate> ===

Revision as of 21:45, 11 February 2020


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