Module conf

Behaviours: application.

This module defines the conf behaviour.
Required callback functions: validator/0.

Authors: Evgeny Khramtsov (xramtsov@gmail.com).

Data Types

apps_config()

apps_config() = [{atom(), #{atom() => term()} | {atom(), term()}}]

backend()

backend() = conf_yaml_backend

error_reason()

error_reason() = {bad_env, conf_env:error_reason()} | {bad_ref, conf_file:ref(), conf_file:error_reason()} | {backend(), term()}

Function Index

config_change/3
format_error/1
get_path/0
load/1
load_file/1
reload/1
reload_file/0
reload_file/1
start/0
start/2
stop/0
stop/1

Function Details

config_change/3

config_change(Changed::[{atom(), term()}], New::[{atom(), term()}], Removed::[atom()]) -> ok

format_error/1

format_error(X1::error_reason()) -> string()

get_path/0

get_path() -> {ok, binary()} | {error, error_reason()}

load/1

load(Y::term()) -> ok | {error, error_reason()}

load_file/1

load_file(Path0::file:filename_all()) -> ok | {error, error_reason()}

reload/1

reload(Y::term()) -> ok | {error, error_reason()}

reload_file/0

reload_file() -> ok | {error, error_reason()}

reload_file/1

reload_file(Path0::file:filename_all()) -> ok | {error, error_reason()}

start/0

start() -> ok | {error, term()}

start/2

start(StartType::normal | {takeover, node()} | {failover, node()}, StartArgs::term()) -> {ok, pid()} | {error, term()}

stop/0

stop() -> ok | {error, term()}

stop/1

stop(State::term()) -> ok


Generated by EDoc