X file:lines: Difference between revisions

From GiderosMobile
redone
No edit summary
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
'''Available since:''' Gideros 2011.6<br/>
'''Available since:''' Gideros 2011.6<br/>
'''Class:''' [[file|file]]<br/>
'''Class:''' [[X File]]<br/>


=== Description ===
=== Description ===
Returns an iterator function that, each time it is called, returns a new line from the file.
Returns an iterator function that, each time it is called, returns a new line from the file.
<source lang="lua">
<syntaxhighlight lang="lua">
(function) = file:lines()
(function) = file:lines()
</source>
</syntaxhighlight>


Unlike '''[[io.lines]]''', this function does not close the file when the loop ends.
Unlike '''[[io.lines]]''', this function does not close the file when the loop ends.
Line 16: Line 16:
=== Example ===
=== Example ===
'''To iterate over all lines of a file'''
'''To iterate over all lines of a file'''
<source lang="lua">
<syntaxhighlight lang="lua">
for line in file:lines() do
for line in file:lines() do
--body
--body
end
end
</source>
</syntaxhighlight>


{{File}}
{{X File}}

Latest revision as of 21:39, 24 January 2026

Available since: Gideros 2011.6
Class: X File

Description

Returns an iterator function that, each time it is called, returns a new line from the file.

(function) = file:lines()

Unlike io.lines, this function does not close the file when the loop ends.

Return values

Returns (function) iterator function

Example

To iterate over all lines of a file

for line in file:lines() do
	--body
end