amoc_config (amoc v4.1.0)

View Source

TODO

See also: amoc_config.

Summary

Types

error/0

-type error() :: {error, error_type(), reason()}.

error_type/0

-type error_type() :: atom().

maybe_module_config/0

-type maybe_module_config() :: {ok, [module_parameter()]} | error().

maybe_update_fun/0

-type maybe_update_fun() :: update_fun() | fun((_, _) -> any()).

maybe_verification_fun/0

-type maybe_verification_fun() :: verification_fun() | fun((_) -> any()).

module_parameter/0

-type module_parameter() ::
          #module_parameter{name :: name(),
                            mod :: module(),
                            value :: value(),
                            description :: unicode:chardata(),
                            verification_fn :: maybe_verification_fun(),
                            update_fn :: maybe_update_fun() | read_only}.

name/0

-type name() :: atom().

reason/0

-type reason() :: any().

settings/0

-type settings() :: [{name(), value()}].

update_fun/0

-type update_fun() :: fun((ParamName :: name(), NewValue :: value()) -> any()).

value/0

-type value() :: any().

verification_fun/0

-type verification_fun() ::
          fun((Value :: value()) -> boolean() | {true, NewValue :: value()} | {false, reason()}).

Functions

get(Name)

-spec get(name()) -> any().

get(Name, Default)

-spec get(name(), value()) -> value().