Difference between revisions of "X file:lines"

Latest revision as of 04:10, 30 July 2025

Available since: Gideros 2011.6
Class: file

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.

Returns (function) iterator function

To iterate over all lines of a file

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

@@ Line 1: / Line 1: @@
 __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()
+</syntaxhighlight>
+Unlike '''[[io.lines]]''', this function does not close the file when the loop ends.
+=== Return values ===
+'''Returns''' (function) iterator function<br/>
- will iterate over all lines of the file. (Unlike io.lines, this function does not close the file when the loop ends.)</translate>
+=== Example ===
-<source lang="lua">
+'''To iterate over all lines of a file'''
-(function) = file:lines()
+<syntaxhighlight lang="lua">
-</source>
+for line in file:lines() do
-=== <translate>Return values</translate> ===
+	--body
-'''<translate>Returns</translate>''' (function) <translate>iterator function</translate><br/>
+end
+</syntaxhighlight>
 {{File}}