Skogsrå v2.2.3 Skogsra.Env View Source

This module defines a Skogsra environment variable.

Link to this section Summary

Types

Application name.

Variable binding.

Variable binding list.

key()

Key.

keys()

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

Variable namespace.

option()

Environment variable options.

Environment variable options

t()

Skogsra environment variable.

type()

Types.

Functions

Environment variable struct.

binding_order(env)

Gets the binding order for a Skogsra environment variable.

Whether the Skogsra environment variable is cached or not.

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.

Gets the OS variable name for the Skogsra environment variable.

Whether the Skogsra environment variable is required or not.

Gets the type of the Skogsra environment variable.

Link to this section Types

app_name()

app_name() :: nil | atom()

Application name.

binding()

binding() :: :config | :system | module()

Variable binding.

bindings()

bindings() :: [binding()]

Variable binding list.

key()

key() :: atom()

Key.

keys()

keys() :: [key()]

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

namespace()

namespace() :: nil | atom()

Variable namespace.

option()

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.

options()

options() :: [option()]

Environment variable options:

t()

t() :: %Skogsra.Env{
  app_name: app_name :: app_name(),
  keys: keys :: keys(),
  namespace: namespace :: namespace(),
  options: options :: options()
}

Skogsra environment variable.

type()

type() ::
  :binary
  | :integer
  | :float
  | :boolean
  | :atom
  | :module
  | :unsafe_module
  | :any
  | module()

Types.

Link to this section Functions

%Skogsra.Env{}

(struct)

Environment variable struct.

binding_order(env)

binding_order(t()) :: bindings()

Gets the binding order for a Skogsra environment variable.

cached?(env)

cached?(t()) :: boolean()

Whether the Skogsra environment variable is cached or not.

default(env)

default(t()) :: term()

Gets the default value for a Skogsra environment variable.

extra_options(env)

extra_options(t()) :: keyword()

Gets extra options.

new(namespace, app_name, keys, options)

new(namespace(), app_name(), key(), options()) :: t()

new(namespace(), app_name(), keys(), options()) :: t()

Creates a new Skogsra environment variable.

os_env(env)

os_env(t()) :: binary()

Gets the OS variable name for the Skogsra environment variable.

required?(env)

required?(t()) :: boolean()

Whether the Skogsra environment variable is required or not.

type(env)

type(t()) :: type() | tuple()

Gets the type of the Skogsra environment variable.