LuaFileSystem Reference Manual

File system library for the Lua programming language

Introduction

LuaFileSystem is a Lua library developed to complement the set of functions related to file systems offered by the standard Lua distribution.

LuaFileSystem is free software and uses the same license as Lua 5.0.

Reference

LuaFileSystem offers the following functions:

• lfs.chdir (path)
  Changes the current working directory to the given path.
• lfs.currentdir ()
  Returns the current working directory or nil plus an error string.
• lfs.dir (path)
  Lua iterator over the entries of a given directory.
• lfs.lock (filehandle, mode[, start[, length]])
  Locks a file or a part of it. This function works on open files; the file handle should be specified as the first argument. The string mode could be either r (for a read/shared lock) or w (for a write/exclusive lock). The optional arguments start and length can be used to specify a starting point and its length; both should be numbers. This function returns a boolean indicating if the operation was successful; in case of error, it returns false plus a string describing the error.
• lfs.mkdir (dirname)
  Creates a new directory. The argument is the name of the new directory.
• lfs.unlock (filehandle[, start[, length]])
  Unlocks a file or a part of it. This function works on open files; the file handle should be specified as the first argument. The optional arguments start and length can be used to specify a starting point and its length; both should be numbers. This function returns a boolean indicating if the operation was successful; in case of error, it returns false plus a string describing the error.

Example

Contents

• Introduction
• Reference
  • chdir
  • currentdir
  • dir
  • lock
  • mkdir
  • unlock
• Examples