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.attributes (filepath)
  Obtains the file attributes. The attributes are:
  dev, device inode resides on;
  ino, inode's number;
  mode, inode protection mode (values could be file, directory, link, socket, named pipe, char device, block device or other);
  nlink, number of hard links to the file;
  uid, user-id of owner;
  gid, group-id of owner;
  rdev, device type, for special file inode;
  access, time of last access;
  modification, time of last data modification;
  change, time of last file status change;
  size, file size, in bytes;
  blocks, block allocated for file; (Unix only)
  blksize, optimal file system I/O blocksize; (Unix only)
  
  Returns a table with file attributes described above.
• lfs.chdir (path)
  Changes the current working directory to the given path.
  Returns true in case of success or nil plus an error string.
• lfs.currentdir ()
  Returns a string with the current working directory or nil plus an error string.
• lfs.dir (path)
  Lua iterator over the entries of a given directory. Raises an error if path is not a 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.
  Returns a boolean indicating if the operation was successful; in case of error, it returns false plus an error string.
• lfs.mkdir (dirname)
  Creates a new directory. The argument is the name of the new directory.
  Returns a boolean indicating whether the operation succeeds or not (in this case, an error string is returned too).
• 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.
  Returns a boolean indicating if the operation was successful; in case of error, it returns false plus a string describing the error.

Example

require"lfs"

function attrdir (path)
    for file in lfs.dir(path) do
        if file ~= "." and file ~= ".." then
            local f = path..'/'..file
            print ("\t "..f)
            local attr = lfs.attributes (f)
            assert (type(attr) == "table")
            if attr.mode == "directory" then
                attrdir (f)
            else
                for name, value in pairs(attr) do
                    print (name, value)
                end
            end
        end
    end
end

attrdir (".")

Contents

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