Difference between revisions of "X file:lines"

From GiderosMobile
(Created page with "__NOTOC__ <languages /> '''<translate>Available since</translate>:''' Gideros 2011.6<br/> '''<translate>Class</translate>:''' file<br/> === <transl...")
 
m (Text replacement - "<source" to "<syntaxhighlight")
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
<languages />
+
'''Available since:''' Gideros 2011.6<br/>
'''<translate>Available since</translate>:''' Gideros 2011.6<br/>
+
'''Class:''' [[file|file]]<br/>
'''<translate>Class</translate>:''' [[Special:MyLanguage/file|file]]<br/>
 
=== <translate>Description</translate> ===
 
<translate>Returns an iterator function that, each time it is called, returns a new line from the file. Therefore, the construction
 
  
    ''for line in file:lines() do body end''
+
=== Description ===
 +
Returns an iterator function that, each time it is called, returns a new line from the file.
 +
<syntaxhighlight lang="lua">
 +
(function) = file:lines()
 +
</source>
  
will iterate over all lines of the file. (Unlike io.lines, this function does not close the file when the loop ends.)</translate>
+
Unlike '''[[io.lines]]''', this function does not close the file when the loop ends.
<source lang="lua">
+
 
(function) = file:lines()
+
=== Return values ===
 +
'''Returns''' (function) iterator function<br/>
 +
 
 +
=== Example ===
 +
'''To iterate over all lines of a file'''
 +
<syntaxhighlight lang="lua">
 +
for line in file:lines() do
 +
--body
 +
end
 
</source>
 
</source>
=== <translate>Return values</translate> ===
 
'''<translate>Returns</translate>''' (function) <translate>iterator function</translate><br/>
 
  
 
{{File}}
 
{{File}}

Latest revision as of 14:32, 13 July 2023

Available since: Gideros 2011.6
Class: file

Description

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

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 <syntaxhighlight lang="lua"> for line in file:lines() do --body end </source>