X File: Difference between revisions

From GiderosMobile
No edit summary
No edit summary
 
(18 intermediate revisions by 2 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
'''Supported platforms:''' android, ios, mac, pc<br/>
<!-- GIDEROSOBJ:file -->
'''Supported platforms:''' [[File:Platform android.png]][[File:Platform ios.png]][[File:Platform mac.png]][[File:Platform pc.png]][[File:Platform html5.png]][[File:Platform winrt.png]][[File:Platform win32.png]][[File:Platform linux.png]]<br/>
'''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>
A '''file''' object is usually returned by [[io.open]] used to manipulate (read and write) files in lua.
 
'''NOTE:''' this page and other related ''file'' methods use an X before the name because '''file''' is reserved by '''MediaWiki'''
 
=== Examples ===
=== Examples ===
'''Copy a file'''<br/>
<syntaxhighlight lang="lua">
<source lang="lua">local function copy(src, dst)
--function to copy file
local function copy(src, dst)
local srcf = io.open(src, "rb")
local srcf = io.open(src, "rb")
local dstf = io.open(dst, "wb")
local dstf = io.open(dst, "wb")
local size = 2^13     -- good buffer size (8K)
 
local size = 2^13 -- good buffer size (8K)
while true do
while true do
local block = srcf:read(size)
local block = srcf:read(size)
Line 17: Line 24:
srcf:close()
srcf:close()
dstf:close()
dstf:close()
end</source>
end
 
--function to check if file exists
local function exists(file)
local f = io.open(file, "rb")
if f == nil then return false end
f:close() return true
end
 
--usage
if not exists("|D|database.db") then
copy("database.db", "|D|database.db")
end
</syntaxhighlight>
 
{|-
{|-
| style="width: 50%;"|
| style="width: 50%; vertical-align:top;"|
=== Methods ===
=== Methods ===
[[file:close]] - closes file<br/>
[[x_file:close|file:close]] ''closes file''<br/><!--GIDEROSMTD:file:close() closes file-->
[[file:flush]] - saves any written data to file<br/>
[[x_file:flush|file:flush]] ''saves any written data to file''<br/><!--GIDEROSMTD:file:flush() saves any written data to file-->
[[file:lines]] - returns iterator function to return lines, nil ends<br/>
[[x_file:lines|file:lines]] ''returns an iterator function''<br/><!--GIDEROSMTD:file:lines() returns an iterator function-->
[[file:read]] - reads file according to given formats, returns read values or nil<br/>
[[x_file:read|file:read]] ''reads file according to given formats, returns read values or nil''<br/><!--GIDEROSMTD:file:read(format1,...) 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<br/>
[[x_file:seek|file:seek]] ''sets file seek pos''<br/><!--GIDEROSMTD:file:seek(whence,offset) sets file seek pos, whence="set"|"cur"|"end", defaults "curr",0, returns file pos-->
[[file:write]] - writes strings or numbers to file<br/>
[[x_file:write|file:write]] ''writes strings or numbers to file''<br/><!--GIDEROSMTD:file:write(value1,...) writes strings or numbers to file-->
| style="width: 50%;"|
 
| style="width: 50%; vertical-align:top;"|
=== Events ===
=== Events ===
=== Constants ===
=== Constants ===
|}
|}
{{GIDEROS IMPORTANT LINKS}}

Latest revision as of 21:14, 24 January 2026

Supported platforms:
Available since: Gideros 2011.6

Description

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

NOTE: this page and other related file methods use an X before the name because file is reserved by MediaWiki

Examples

--function to copy 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

--function to check if file exists
local function exists(file)
	local f = io.open(file, "rb")
	if f == nil then return false end
	f:close() return true
end

--usage
if not exists("|D|database.db") then
	copy("database.db", "|D|database.db")
end

Methods

file:close closes file
file:flush saves any written data to file
file:lines returns an iterator function
file:read reads file according to given formats, returns read values or nil
file:seek sets file seek pos
file:write writes strings or numbers to file

Events

Constants