options() = #{prune => boolean(), start_module => module() | undefined, application_module => module() | undefined, include_lines => boolean()}
parsed_file() = [{string(), term()}]
path() = string()
create/2 | Create an AVM file. |
create/3 | Create an AVM file. |
create/4 | (Deprecated.) Create an AVM file. |
create/5 | (Deprecated.) Create an AVM file. |
delete/3 | Delete selected elements of an AVM file. |
extract/3 | Extract all or selected elements from an AVM file. |
list/1 | List the contents of an AVM file. |
create(OutputPath::path(), InputPaths::[path()]) -> ok | {error, Reason::term()}
OutputPath: the path to write the AVM file
InputPaths: a list of paths of beam files, AVM files, or normal data files
returns: ok if the file was created.
throws string()
Create an AVM file.
Equivalent to create(OutputPath, InputPaths, DefaultOptions)
DefaultOptions
is #{
prune => false,
start_module => undefined,
application_module => undefined,
include_lines => false
}
create(OutputPath::path(), InputPaths::[path()], Options::options()) -> ok | {error, Reason::term()}
OutputPath: the path to write the AVM file
InputPaths: a list of paths of beam files, AVM files, or normal data files
Options: creation options
returns: ok if the file was created.
throws string()
Create an AVM file.
This function will create an AVM file at the location specified in OutputPath, using the input files specified in InputPaths.create(OutputPath::path(), InputPaths::[path()], Prune::boolean(), StartModule::module() | undefined) -> ok | {error, Reason::term()}
OutputPath: the path to write the AVM file
InputPaths: a list of paths of beam files, AVM files, or normal data files
Prune: whether to prune the archive. Without pruning, all found BEAM files are included
in the output AVM file. With pruning, then packbeam will attempt to
determine which BEAM files are needed to run the application, depending
on which modules are (transitively) referenced from the AVM entrypoint.
StartModule: if undefined
, then this parameter is a module that
is intended to the the start module for the application. This module
will occur first in the generated AVM file.
returns: ok if the file was created.
throws string()
This function is deprecated: This function is deprecated. Use create/3
instead.
Create an AVM file.
Equivalent to create(OutputPath, InputPaths, undefined, Prune, StartModule).create(OutputPath::path(), InputPaths::[path()], ApplicationModule::module() | undefined, Prune::boolean(), StartModule::module() | undefined) -> ok | {error, Reason::term()}
OutputPath: the path to write the AVM file
InputPaths: a list of paths of beam files, AVM files, or normal data files
ApplicationModule: If not undefined
, then this parameter designates
the name of an OTP application, from which additional dependencies
will be computed.
Prune: whether to prune the archive. Without pruning, all found BEAM files are included
in the output AVM file. With pruning, then packbeam will attempt to
determine which BEAM files are needed to run the application, depending
on which modules are (transitively) referenced from the AVM entrypoint.
StartModule: if undefined
, then this parameter is a module that
is intended to the the start module for the application. This module
will occur first in the generated AVM file.
returns: ok if the file was created.
throws string()
This function is deprecated: This function is deprecated. Use create/3
instead.
Create an AVM file.
This function will create an AVM file at the location specified in OutputPath, using the input files specified in InputPaths.delete(OutputPath::path(), InputPath::path(), Name::[path()]) -> ok | {error, Reason::term()}
OutputPath: the path to write the AVM file
InputPath: the AVM file from which to delete elements
returns: ok if the file was created.
throws string()
Delete selected elements of an AVM file.
This function will delete elements of an AVM file at the location specified in InputPath, specified by the supplied list of names. The output AVM file is written to OutputPath, which may be the same as InputPath.extract(InputPath::path(), Names::[path()], OutputDir::path()) -> ok | {error, Reason::term()}
InputPath: the AVM file from which to extract elements
Names: a list of elements from the source AVM file to extract. If
empty, then extract all elements.
OutputDir: the directory to write the contents
returns: ok if the file was created.
throws string()
Extract all or selected elements from an AVM file.
This function will extract elements of an AVM file at the location specified in InputPath, specified by the supplied list of names. The elements from the input AVM file will be written into the specified output directory, creating any subdirectories if the AVM file elements contain path information.list(InputPath::path()) -> [parsed_file()]
InputPath: the AVM file from which to list elements
returns: list of parsed file data
throws string()
List the contents of an AVM file.
This function will list the contents of an AVM file at the location specified in InputPath.Generated by EDoc