distillery

v2.0.0-rc.1

distillery v2.0.0-rc.1 Mix.Releases.App

Represents important metadata about a given application.

Link to this section Summary

Types

start_type()
t()

Functions

new(name, loaded_deps)

Create a new Application struct from an application name

new(name, start_type, loaded_deps)

Same as new/1, but specify the application’s start type

valid_start_type?(start_type)

Determines if the provided start type is a valid one

Link to this section Types

Link to this type start_type() 
start_type() :: :permanent | :temporary | :transient | :load | :none
Link to this type t() 
t() :: %Mix.Releases.App{
  applications: [atom()],
  included_applications: [atom()],
  name: atom(),
  path: nil | String.t(),
  start_type: start_type(),
  unhandled_deps: [atom()],
  vsn: String.t()
}

Link to this section Functions

Link to this function new(name, loaded_deps) 
new(atom(), [Mix.Dep.t()]) :: nil | Mix.Releases.App.t() | {:error, String.t()}

Create a new Application struct from an application name

Link to this function new(name, start_type, loaded_deps) 
new(atom(), start_type() | nil, [Mix.Dep.t()]) ::
  nil | Mix.Releases.App.t() | {:error, String.t()}

Same as new/1, but specify the application’s start type

Link to this function valid_start_type?(start_type) 
valid_start_type?(atom()) :: boolean()

Determines if the provided start type is a valid one.