Skogsrå v2.4.0

View Source Skogsra.Env (Skogsrå v2.4.0)

This module defines a Skogsra environment variable.

Link to this section Summary

Types

app_name()

Application name.

binding()

Variable binding.

bindings()

Variable binding list.

key()

Key.

keys()

List of keys that lead to the value of the variable.

namespace()

Variable namespace.

option()

Environment variable options.

options()

Environment variable options

t()

Skogsra environment variable.

type()

Types.

Functions

%Skogsra.Env{}

Environment variable struct.

binding_order(env)

Gets the binding order for a Skogsra environment variable.

cached?(env)

Whether the Skogsra environment variable is cached or not.

default(env)

Gets the default value for a Skogsra environment variable.

extra_options(env)

Gets extra options.

new(namespace, app_name, keys, options)

Creates a new Skogsra environment variable.

os_env(env)

Gets the OS variable name for the Skogsra environment variable.

required?(env)

Whether the Skogsra environment variable is required or not.

type(env)

Gets the type of the Skogsra environment variable.

Link to this section Types

Link to this type

app_name()

View Source 
@type app_name() :: nil | atom()

Application name.

Link to this type

binding()

View Source 
@type binding() :: :config | :system | module()

Variable binding.

Link to this type

bindings()

View Source 
@type bindings() :: [binding()]

Variable binding list.

Link to this type

key()

View Source 
@type key() :: atom()

Key.

Link to this type

keys()

View Source 
@type keys() :: [key()]

List of keys that lead to the value of the variable.

Link to this type

namespace()

View Source 
@type namespace() :: nil | atom()

Variable namespace.

Link to this type

option()

View Source 
@type option() ::
  {:binding_order, bindings()}
  | {:binding_skip, bindings()}
  | {:os_env, binary()}
  | {:type, type()}
  | {:namespace, namespace()}
  | {:default, term()}
  | {:required, boolean()}
  | {:cached, boolean()}
  | {atom(), term()}

Environment variable options.

  • binding_order - Variable binding load order.
  • binding_skip - Skips loading a variable from the list of bindings.
  • os_env - The name of the OS environment variable.
  • type - Type to cast the OS environment variable value.
  • namespace - Default namespace for the variable.
  • default - Default value.
  • required - Whether the variable is required or not.
  • cached - Whether the variable is cached or not.
Link to this type

options()

View Source 
@type options() :: [option()]

Environment variable options:

Link to this type

t()

View Source 
@type t() :: %Skogsra.Env{
  app_name: app_name :: app_name(),
  keys: keys :: keys(),
  namespace: namespace :: namespace(),
  options: options :: options()
}

Skogsra environment variable.

Link to this type

type()

View Source 
@type type() ::
  :binary
  | :integer
  | :neg_integer
  | :non_neg_integer
  | :pos_integer
  | :float
  | :boolean
  | :atom
  | :module
  | :unsafe_module
  | :any
  | module()

Types.

Link to this section Functions

Link to this function

%Skogsra.Env{}

View Source (struct)

Environment variable struct.

Link to this function

binding_order(env)

View Source 
@spec binding_order(t()) :: bindings()

Gets the binding order for a Skogsra environment variable.

Link to this function

cached?(env)

View Source 
@spec cached?(t()) :: boolean()

Whether the Skogsra environment variable is cached or not.

Link to this function

default(env)

View Source 
@spec default(t()) :: term()

Gets the default value for a Skogsra environment variable.

Link to this function

extra_options(env)

View Source 
@spec extra_options(t()) :: keyword()

Gets extra options.

Link to this function

new(namespace, app_name, keys, options)

View Source 
@spec new(namespace(), app_name(), key(), options()) :: t()
@spec new(namespace(), app_name(), keys(), options()) :: t()

Creates a new Skogsra environment variable.

Link to this function

os_env(env)

View Source 
@spec os_env(t()) :: binary()

Gets the OS variable name for the Skogsra environment variable.

Link to this function

required?(env)

View Source 
@spec required?(t()) :: boolean()

Whether the Skogsra environment variable is required or not.

Link to this function

type(env)

View Source 
@spec type(t()) :: type() | tuple()

Gets the type of the Skogsra environment variable.