6 – Standard Libraries

The standard Lua libraries provide useful functions that are implemented directly through the C API. Some of these functions provide essential services to the language (e.g., type and getmetatable); others provide access to "outside" services (e.g., I/O); and others could be implemented in Lua itself, but are quite useful or have critical performance requirements that deserve an implementation in C (e.g., table.sort).

All libraries are implemented through the official C API and are provided as separate C modules. Currently, Lua has the following standard libraries:

  • basic library (§6.1);
  • coroutine library (§6.2);
  • package library (§6.3);
  • string manipulation (§6.4);
  • basic UTF-8 support (§6.5);
  • table manipulation (§6.6);
  • mathematical functions (§6.7) (sin, log, etc.);
  • input and output (§6.8);
  • operating system facilities (§6.9);
  • debug facilities (§6.10).

Except for the basic and the package libraries, each library provides all its functions as fields of a global table or as methods of its objects.

To have access to these libraries, the C host program should call the luaL_openlibs function, which opens all standard libraries. Alternatively, the host program can open them individually by using luaL_requiref to call luaopen_base (for the basic library), luaopen_package (for the package library), luaopen_coroutine (for the coroutine library), luaopen_string (for the string library), luaopen_utf8 (for the UTF8 library), luaopen_table (for the table library), luaopen_math (for the mathematical library), luaopen_io (for the I/O library), luaopen_os (for the operating system library), and luaopen_debug (for the debug library). These functions are declared in lualib.h.

io.type()
  • References/Lua/Lua/Standard Libraries/Input and Output Facilities

io.type (obj) Checks whether obj is a valid file handle. Returns the string "file" if obj is an open file handle, "closed file"

2025-01-10 15:47:30
math.deg()
  • References/Lua/Lua/Standard Libraries/Mathematical Functions

math.deg (x) Converts the angle x from radians to degrees.

2025-01-10 15:47:30
coroutine.yield()
  • References/Lua/Lua/Standard Libraries/Coroutine Manipulation

coroutine.yield (···) Suspends the execution of the calling coroutine. Any arguments to yield are passed as extra results to resume.

2025-01-10 15:47:30
Patterns
  • References/Lua/Lua/Standard Libraries/String Manipulation

6.4.1 – Patterns Patterns in Lua are described by regular strings, which are interpreted as patterns by the pattern-matching functions

2025-01-10 15:47:30
debug.getuservalue()
  • References/Lua/Lua/Standard Libraries/The Debug Library

debug.getuservalue (u) Returns the Lua value associated to u. If u is not a full userdata, returns nil.

2025-01-10 15:47:30
string.rep()
  • References/Lua/Lua/Standard Libraries/String Manipulation

string.rep (s, n [, sep])nssepsepn (Note that it is very easy to exhaust the memory of your machine with a single

2025-01-10 15:47:30
string.gmatch()
  • References/Lua/Lua/Standard Libraries/String Manipulation

string.gmatch (s, pattern)pattern§6.4.1spattern As

2025-01-10 15:47:30
string.upper()
  • References/Lua/Lua/Standard Libraries/String Manipulation

string.upper (s)

2025-01-10 15:47:30
dofile()
  • References/Lua/Lua/Standard Libraries/Basic Functions

dofile ([filename])dofilestdindofiledofile

2025-01-10 15:47:30
debug.getregistry()
  • References/Lua/Lua/Standard Libraries/The Debug Library

debug.getregistry () Returns the registry table (see §4.5).

2025-01-10 15:47:30