Summary

Returns an iterator function for reading a named file line-by-line

Prototype

it = io.lines (filename)

Description

Opens filename for input in text mode. Raises an error if it cannot.

If opened OK returns an iterator function that reads the file line-by-line.

At end of file, returns nil and closes the file.

If filename not supplied, uses the default input file.

for line in io.lines ("test.txt") do
  print (line)
end 

 --> Entire contents of file listed

See Also ...

Lua functions

f:close - Closes a file
f:flush - Flushes outstanding data to disk
f:lines - Returns an iterator function for reading the file line-by-line
f:read - Reads the file according to the specified formats
f:seek - Sets and gets the current file position
f:setvbuf - Sets the buffering mode for an output file
f:write - Writes to a file
io.close - Closes a file
io.flush - Flushes outstanding data to disk for the default output file
io.input - Opens filename for input in text mode
io.open - Opens a file
io.output - Opens a file for output
io.popen - Creates a pipe and executes a command
io.read - Reads from the default input file
io.stderr - File handle for standard error file
io.stdin - File handle for standard input file
io.stdout - File handle for standard output file
io.tmpfile - Returns a handle to a temporary file
io.type - Returns type of file handle
io.write - Writes to the default output file

Topics

Lua base functions
Lua bc (big number) functions
Lua bit manipulation functions
Lua coroutine functions
Lua debug functions
Lua io functions
Lua math functions
Lua os functions
Lua package functions
Lua PCRE regular expression functions
Lua script extensions
Lua string functions
Lua syntax
Lua table functions
Lua utilities
Scripting
Scripting callbacks - plugins

(Help topic: lua=io.lines)