io.lines
Lua function

io.lines

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 ...

Topics

DOC_lua_base Lua base functions
DOC_lua_bc Lua bc (big number) functions
DOC_lua_bit Lua bit manipulation functions
DOC_lua_coroutines Lua coroutine functions
DOC_lua_debug Lua debug functions
DOC_lua_io Lua io functions
DOC_lua_math Lua math functions
DOC_lua_os Lua os functions
DOC_lua_package Lua package functions
DOC_lua_rex Lua PCRE regular expression functions
DOC_lua Lua script extensions
DOC_lua_string Lua string functions
DOC_lua_tables Lua table functions
DOC_lua_utils Lua utilities
DOC_scripting Scripting

Lua functions

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

(Help topic: lua=io.lines)

DOC_contents Documentation contents page