Elixir v1.9.1 Kernel.ParallelCompiler View Source
A module responsible for compiling and requiring files in parallel.
Link to this section Summary
Functions
Starts a task for parallel compilation.
Compiles the given files.
Requires the given files in parallel.
Link to this section Functions
Starts a task for parallel compilation.
If you have a file that needs to compile other modules in parallel, the spawned processes need to be aware of the compiler environment. This function allows a developer to create a task that is aware of those environments.
See Task.async/1
for more information. The task spawned must be
always awaited on by calling Task.await/1
Compiles the given files.
Those files are compiled in parallel and can automatically detect dependencies between them. Once a dependency is found, the current file stops being compiled until the dependency is resolved.
It returns {:ok, modules, warnings}
or {:error, errors, warnings}
.
Both errors and warnings are a list of three-element tuples containing the file, line and the formatted error/warning.
Options
:each_file
- for each file compiled, invokes the callback passing the file:each_long_compilation
- for each file that takes more than a given timeout (see the:long_compilation_threshold
option) to compile, invoke this callback passing the file as its argument:each_module
- for each module compiled, invokes the callback passing the file, module and the module bytecode:each_cycle
- after the given files are compiled, invokes this function that return a list with potentially more files to compile:long_compilation_threshold
- the timeout (in seconds) after the:each_long_compilation
callback is invoked; defaults to15
:dest
- the destination directory for the BEAM files. When usingcompile/2
, this information is only used to properly annotate the BEAM files before they are loaded into memory. If you want a file to actually be written todest
, usecompile_to_path/3
instead.
Requires the given files in parallel.
Opposite to compile, dependencies are not attempted to be automatically solved between files.
It returns {:ok, modules, warnings}
or {:error, errors, warnings}
.
Both errors and warnings are a list of three-element tuples containing the file, line and the formatted error/warning.
Options
:each_file
- for each file compiled, invokes the callback passing the file:each_module
- for each module compiled, invokes the callback passing the file, module and the module bytecode