LDoc/builtin/lfs.luadoc at 0.4.2 · hishamhm/LDoc

Repository navigation

History

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

--- LuaFileSystem.

module 'lfs'

---

-- Returns a table with the file attributes corresponding to filepath (or nil

-- followed by an error message in case of error). If the second optional

-- argument is given, then only the value of the named attribute is returned

-- (this use is equivalent to lfs.attributes(filepath).aname, but the table is

-- not created and only one attribute is retrieved from the O.S.). The

-- attributes are described as follows; attribute mode is a string, all the

-- others are numbers, and the time related attributes use the same time

-- reference of os.time:

-- - dev: on Unix systems, this represents the device that the inode resides on.

-- On Windows systems, represents the drive number of the disk containing

-- the file

-- - ino: on Unix systems, this represents the inode number. On Windows systems

-- this has no meaning

-- - mode: string representing the associated protection mode (the 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 (Unix only, always 0 on Windows)

-- - gid: group-id of owner (Unix only, always 0 on Windows)

-- - rdev: on Unix systems, represents the device type, for special file inodes.

-- On Windows systems represents the same as dev

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

-- This function uses stat internally thus if the given filepath is a symbolic

-- link, it is followed (if it points to another link the chain is followed

-- recursively) and the information is about the file it refers to. To obtain

-- information about the link itself, see function lfs.symlinkattributes.

function lfs.attributes(filepath [, aname]) end

---

-- Changes the current working directory to the given path.

-- Returns true in case of success or nil plus an error string.

function lfs.chdir(path) end

---

-- Creates a lockfile (called lockfile.lfs) in path if it does not exist and

-- returns the lock. If the lock already exists checks it it's stale, using the

-- second parameter (default for the second parameter is INT_MAX, which in

-- practice means the lock will never be stale. To free the the lock call

-- lock:free().

-- In case of any errors it returns nil and the error message. In particular,

-- if the lock exists and is not stale it returns the "File exists" message.

function lfs.lock_dir(path, [seconds_stale]) end

---

-- Returns a string with the current working directory or nil plus an error

-- string.

function lfs.currentdir() end

---

-- Lua iterator over the entries of a given directory. Each time the iterator is

-- called with dir_obj it returns a directory entry's name as a string, or nil

-- if there are no more entries. You can also iterate by calling `dir_obj:next()`,

-- and explicitly close the directory before the iteration finished with

-- `dir_obj:close()`. Raises an error if path is not a directory.

function lfs.dir(path) end

---

-- 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 true if the operation was successful; in case of error, it returns

-- nil plus an error string.

function lfs.lock(filehandle, mode[, start[, length]])

---

-- Creates a new directory. The argument is the name of the new directory.

-- Returns true if the operation was successful; in case of error, it returns

-- nil plus an error string.

function lfs.mkdir(dirname) end

---

-- Removes an existing directory. The argument is the name of the directory.

-- Returns true if the operation was successful; in case of error, it returns

-- nil plus an error string.

function lfs.rmdir(dirname) end

---

-- Sets the writing mode for a file. The mode string can be either binary or

-- text. Returns the previous mode string for the file. This function is only

-- available in Windows, so you may want to make sure that lfs.setmode exists

-- before using it.

function lfs.setmode(file, mode) end

---

-- Identical to lfs.attributes except that it obtains information about the link

-- itself (not the file it refers to). This function is not available in Windows

-- so you may want to make sure that lfs.symlinkattributes exists before using

-- it.

function lfs.symlinkattributes(filepath [, aname]) end

---

-- Set access and modification times of a file. This function is a bind to utime

-- function. The first argument is the filename, the second argument (atime) is

-- the access time, and the third argument (mtime) is the modification time.

-- Both times are provided in seconds (which should be generated with Lua

-- standard function os.time). If the modification time is omitted, the access

-- time provided is used; if both times are omitted, the current time is used.

-- Returns true if the operation was successful; in case of error, it returns

-- nil plus an error string.

function lfs.touch(filepath [, atime [, mtime]]) end

---

-- 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 true if the operation was successful; in case of error, it returns

-- nil plus an error string.

function lfs.unlock(filehandle[, start[, length]]) end

FilesExpand file tree

lfs.luadoc

Latest commit

History

lfs.luadoc

File metadata and controls