Module rlx_app_info

This module represents useful, relevant information about an application.

Copyright © (C) 2012 Erlware, LLC.

Authors: Eric Merritt (ericbmerritt@gmail.com).

Description

This module represents useful, relevant information about an application. The relevant information is.

<ul> <li> Name - The application name as an atom </li> <li> Vsn - The application version as a list </li> <li> The root directory of the application. The directory that contains the ebin/src/priv etc </li> <li> Active Deps - The Active or 'application' dependencies of the OTP App. That is the things in the 'applications' property of the application metadata </li> <li> Library Deps - The Inactive or Library dependencies of the ATP app. That is the things in the 'included_applications property of the application metadata. </ul>

Data Types

t()

abstract datatype: t()

Function Index

active_deps/1
active_deps/2
dir/1
dir/2
format/1
format/2
format_error/1
library_deps/1
library_deps/2
link/1
link/2
name/1
name/2
new/0Build a new, empty, app info value.
new/5build a complete version of the app info with all fields set.
original_vsn/1
vsn/1
vsn/2
vsn_as_string/1

Function Details

active_deps/1

active_deps(App_info_t::t()) -> [atom()]

active_deps/2

active_deps(AppInfo::t(), ActiveDeps::[atom()]) -> t()

dir/1

dir(App_info_t::t()) -> binary()

dir/2

dir(AppInfo::t(), Dir::binary()) -> t()

format/1

format(AppInfo::t()) -> iolist()

format/2

format(Indent::non_neg_integer(), App_info_t::t()) -> iolist()

format_error/1

format_error(Reason::term()) -> iolist()

library_deps/1

library_deps(App_info_t::t()) -> [atom()]

library_deps/2

library_deps(AppInfo::t(), LibraryDeps::[atom()]) -> t()

link/1

link(App_info_t::t()) -> boolean()

link/2

link(AppInfo::t(), NewLink::boolean()) -> t()

name/1

name(App_info_t::t()) -> atom()

name/2

name(AppInfo::t(), AppName::atom()) -> t()

new/0

new() -> {ok, t()}

Build a new, empty, app info value. This is not of a lot of use and you probably wont be doing this much.

new/5

new(AppName::atom(), Vsn::string(), Dir::binary(), ActiveDeps::[atom()], LibraryDeps::[atom()]) -> {ok, t()} | relx:error()

build a complete version of the app info with all fields set.

original_vsn/1

original_vsn(App_info_t::t()) -> string()

vsn/1

vsn(App_info_t::t()) -> ec_semver:semver()

vsn/2

vsn(AppInfo::t(), AppVsn::string()) -> {ok, t()} | relx:error()

vsn_as_string/1

vsn_as_string(App_info_t::t()) -> string()


Generated by EDoc, Jun 11 2024, 05:32:01.