distillery

v1.2.0

distillery v1.2.0 Mix.Releases.App

Represents important metadata about a given application.

Summary

Types

start_type()
t()

Functions

new(name)

Create a new Application struct from an application name

new(name, start_type)

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

Types

start_type() 
start_type() :: :permanent | :temporary | :transient | :load | :none
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}

Functions

new(name) 
new(atom) :: nil | Mix.Releases.App.t | {:error, String.t}

Create a new Application struct from an application name

new(name, start_type) 
new(atom, start_type | nil) ::
  nil |
  Mix.Releases.App.t |
  {:error, String.t}

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

valid_start_type?(start_type) 
valid_start_type?(atom) :: boolean

Determines if the provided start type is a valid one.