luarocks

• Index

Contents

• Functions

Modules

• luarocks.add
• luarocks.build
• luarocks.build.builtin
• luarocks.build.cmake
• luarocks.build.command
• luarocks.build.lake
• luarocks.build.make
• luarocks.cache
• luarocks.cfg
• luarocks.command_line
• luarocks.config
• luarocks.deps
• luarocks.dir
• luarocks.download
• luarocks.fetch
• luarocks.fetch.cvs
• luarocks.fetch.git
• luarocks.fetch.sscm
• luarocks.fetch.svn
• luarocks.fs
• luarocks.fs.lua
• luarocks.fs.unix
• luarocks.fs.unix.tools
• luarocks.fs.win32
• luarocks.fs.win32.tools
• luarocks.help
• luarocks.index
• luarocks.install
• luarocks.list
• luarocks.loader
• luarocks.make
• luarocks.make_manifest
• luarocks.manif
• luarocks.manif_core
• luarocks.pack
• luarocks.path
• luarocks.persist
• luarocks.refresh_cache
• luarocks.remove
• luarocks.rep
• luarocks.require
• luarocks.search
• luarocks.show
• luarocks.tools.tar
• luarocks.tools.zip
• luarocks.type_check
• luarocks.unpack
• luarocks.util
• luarocks.validate

Module luarocks.fetch

Functions related to fetching and loading local and remote files.

Functions

fetch_url (url, filename)	Fetch a local or remote file.
fetch_url_at_temp_dir (url, tmpname, filename)	For remote URLs, create a temporary directory and download URL inside it.
fetch_and_unpack_rock (rock_file, dest)	Obtain a rock and unpack it.
load_local_rockspec (file, filename)	Back-end function that actually loads the local rockspec.
load_rockspec (filename, location)	Load a local or remote rockspec into a table.
get_sources (rockspec, extract, dest_dir)	Download sources for building a rock using the basic URL downloader.
fetch_sources (rockspec, extract, dest_dir)	Download sources for building a rock, calling the appropriate protocol method.

Functions

fetch_url (url, filename)

Fetch a local or remote file. Make a remote or local URL/pathname local, fetching the file if necessary. Other "fetch" and "load" functions use this function to obtain files. If a local pathname is given, it is returned as a result.

Parameters:

• url: string: a local pathname or a remote URL.
• filename: string or nil: this function attempts to detect the resulting local filename of the remote file as the basename of the URL; if that is not correct (due to a redirection, for example), the local filename can be given explicitly as this second argument.

Returns:

string or (nil, string, [string]): the absolute local pathname for the fetched file, or nil and a message in case of errors, followed by an optional error code.

fetch_url_at_temp_dir (url, tmpname, filename)

For remote URLs, create a temporary directory and download URL inside it. This temporary directory will be deleted on program termination. For local URLs, just return the local pathname and its directory.

Parameters:

• url: string: URL to be downloaded
• tmpname: string: name pattern to use for avoiding conflicts when creating temporary directory.
• filename: string or nil: local filename of URL to be downloaded, in case it can't be inferred from the URL.

Returns:

(string, string) or (nil, string, [string]): absolute local pathname of the fetched file and temporary directory name; or nil and an error message followed by an optional error code

fetch_and_unpack_rock (rock_file, dest)

Obtain a rock and unpack it. If a directory is not given, a temporary directory will be created, which will be deleted on program termination.

Parameters:

• rock_file: string: URL or filename of the rock.
• dest: string or nil: if given, directory will be used as a permanent destination.

Returns:

string or (nil, string, [string]): the directory containing the contents of the unpacked rock.

load_local_rockspec (file, filename)

Back-end function that actually loads the local rockspec. Performs some validation and postprocessing of the rockspec contents.

Parameters:

• file: string: The local filename of the rockspec file.
• filename:

Returns:

table or (nil, string): A table representing the rockspec or nil followed by an error message.

load_rockspec (filename, location)

Load a local or remote rockspec into a table. This is the entry point for the LuaRocks tools. Only the LuaRocks runtime loader should use load_local_rockspec directly.

Parameters:

• filename: string: Local or remote filename of a rockspec.
• location: string or nil: Where to download. If not given, a temporary dir is created.

Returns:

table or (nil, string, [string]): A table representing the rockspec or nil followed by an error message and optional error code.

get_sources (rockspec, extract, dest_dir)

Download sources for building a rock using the basic URL downloader.

Parameters:

• rockspec: table: The rockspec table
• extract: boolean: Whether to extract the sources from the fetched source tarball or not.
• dest_dir: string or nil: If set, will extract to the given directory.

Returns:

(string, string) or (nil, string, [string]): The absolute pathname of the fetched source tarball and the temporary directory created to store it; or nil and an error message and optional error code.

fetch_sources (rockspec, extract, dest_dir)

Download sources for building a rock, calling the appropriate protocol method.

Parameters:

• rockspec: table: The rockspec table
• extract: boolean: When downloading compressed formats, whether to extract the sources from the fetched archive or not.
• dest_dir: string or nil: If set, will extract to the given directory.

Returns:

(string, string) or (nil, string): The absolute pathname of the fetched source tarball and the temporary directory created to store it; or nil and an error message.