Module lfs LuaFileSystem.

Type `lfs`

lfs.attributes(filepath, aname)	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.
lfs.chdir(path)	Changes the current working directory to the given path.
lfs.currentdir()	Returns a string with the current working directory.
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.
lfs.lock_dir(path, seconds_stale)	Creates a lockfile (called lockfile.lfs) in path if it does not exist and returns the lock.
lfs.mkdir(dirname)	Creates a new directory.
lfs.rmdir(dirname)	Removes an existing directory.
lfs.setmode(file, mode)	Sets the writing mode for a file.
lfs.symlinkattributes(filepath, aname)	Identical to #lfs.attributes except that it obtains information about the link itself (not the file it refers to).
lfs.touch(filepath, atime, mtime)	Set access and modification times of a file.
lfs.unlock(filehandle, start, length)	Unlocks a file or a part of it.

Type `lfs`

Field(s)

`lfs.attributes(filepath, aname)`

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.

Parameters

filepath: The filename.
aname:
Where aname is an attribute. 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)

Return values

#table: File attributes corresponding to filepath 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.).
#nil, #string: In error cases, error string is provided.

`lfs.chdir(path)`

Changes the current working directory to the given path.

Parameter

path: Targeted directory

Return value

#nil, #string: In error cases, error string is provided.

`lfs.currentdir()`

Returns a string with the current working directory.

Return values

#string: Current working directory
#nil, #string: In error cases, error string is provided.

`lfs.dir(path)`

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.

Parameter

path: Directory to browse

Return value

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. Returns true if the operation was successful; in case of error, it returns nil plus an error string.

Parameters

filehandle: Opened file
mode: "r" or "w"
start: (optional) Starting point.
length: (optional)

Return values

#boolean: true if the operation was successful
#nil, #string: In error cases, error string is provided.

`lfs.lock_dir(path, seconds_stale)`

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 particular, if the lock exists and is not stale it returns the "File exists" message.

Parameters

path: to lock
seconds_stale: tried when path already contains lockfile.lfs .

Return values

io#file: lock In case of success
#nil, #string: In error cases, error string is provided.

`lfs.mkdir(dirname)`

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.

Parameter

dirname: Name of the new directory.

Return values

#boolean: true if the operation was successful
#nil, #string: In error cases, error string is provided.

`lfs.rmdir(dirname)`

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.

Parameter

dirname: Name of the directory to delete.

Return values

#boolean: true if the operation was successful
#nil, #string: In error cases, error string is provided.

`lfs.setmode(file, mode)`

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.

Parameters

file:
mode: The mode string can be either binary or text.

Return value

The previous mode string for the file.

`lfs.symlinkattributes(filepath, aname)`

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.

Parameters

filepath: The filename.
aname: An attribute name as in #lfs.attributes.

Return value

As in #lfs.attributes.

`lfs.touch(filepath, atime, mtime)`

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.

Parameters

filepath: The filename.
atime: The access time in seconds.
mtime: (optional) The modification time in seconds.

Return values

#boolean: true if the operation was successful.
#nil, #string: In error cases, error string is provided.

`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 true if the operation was successful; in case of error, it returns nil plus an error string.

Parameters

filehandle: Opened file
start: (optional) Starting point.
length: (optional)

Return values

#boolean: true if the operation was successful.
#nil, #string: In error cases, error string is provided.

Type lfs

Type lfs

Field(s)

lfs.attributes(filepath, aname)

Parameters

Return values

lfs.chdir(path)

Parameter

Return value

lfs.currentdir()

Return values

lfs.dir(path)

Parameter

Return value

lfs.lock(filehandle, mode, start, length)

Parameters

Return values

lfs.lock_dir(path, seconds_stale)

Parameters

Return values

lfs.mkdir(dirname)

Parameter

Return values

lfs.rmdir(dirname)

Parameter

Return values

lfs.setmode(file, mode)

Parameters

Return value

lfs.symlinkattributes(filepath, aname)

Parameters

Return value

lfs.touch(filepath, atime, mtime)

Parameters

Return values

lfs.unlock(filehandle, start, length)

Parameters

Return values

Type `lfs`

Type `lfs`

`lfs.attributes(filepath, aname)`

`lfs.chdir(path)`

`lfs.currentdir()`

`lfs.dir(path)`

`lfs.lock(filehandle, mode, start, length)`

`lfs.lock_dir(path, seconds_stale)`

`lfs.mkdir(dirname)`

`lfs.rmdir(dirname)`

`lfs.setmode(file, mode)`

`lfs.symlinkattributes(filepath, aname)`

`lfs.touch(filepath, atime, mtime)`

`lfs.unlock(filehandle, start, length)`