| Overview |  |
| conf_get/2 | conf_get/2 is a convenience wrapper for proplists:get_value/2 for schema writers. |
| conf_get/3 | conf_get/3 works just like proplists:get_value/3. |
| invalid/1 | When called inside a translation, informs the user that input configuration is invalid, using the supplied reason string. |
| otp/2 | is ActualOTPVersion >= DesiredMinimumOTPVersion?. |
| otp/3 | If DesiredMinimum =< the OTP you're running, then return IfGreaterOrEqual, otherwise IfLessThan. |
| unset/0 | When called inside a translation, tells cuttlefish to omit the Erlang setting from the generated configuration. |
| warn/1 | When called inside a translation, results in a warning message being logged. |
conf_get(T::string() | cuttlefish_variable:variable(), ConfigProplist::cuttlefish_conf:conf()) -> any()
conf_get/2 is a convenience wrapper for proplists:get_value/2 for schema writers. Keys to a Conf proplist are variable()s which are a list of strings. This function will look for those, but if you pass it a string() instead, it will be nice and split that string on "." since that's how cuttlefish do. Also, it will throw(not_found) if the key is not found in the list which is different that proplists:get_value/2's default behavior of returning 'undefined'. This makes it easy for cuttlefish translations to abort and on error, and not assume a value. If that's what you want, please use conf_get/3. formerly cuttlefish_util:conf_get_value/2
conf_get(T::string() | cuttlefish_variable:variable(), ConfigProplist::cuttlefish_conf:conf(), Default::any()) -> any()
conf_get/3 works just like proplists:get_value/3. It expects a variable() as the Key, but is nice enough to take a string() and split it on "." formerly cuttlefish_util:conf_get_value/3
invalid(Reason::string()) -> no_return()
When called inside a translation, informs the user that input configuration is invalid, using the supplied reason string.
otp(TMin::string(), Ver::string()) -> boolean()
is ActualOTPVersion >= DesiredMinimumOTPVersion?
otp(DesiredMinimumOTPVersion::string(), IfGreaterOrEqual::any(), IfLessThan::any()) -> any()
If DesiredMinimum =< the OTP you're running, then return IfGreaterOrEqual, otherwise IfLessThan.
unset() -> no_return()
When called inside a translation, tells cuttlefish to omit the Erlang setting from the generated configuration.
warn(Str::iodata()) -> ok
When called inside a translation, results in a warning message being logged.
Generated by EDoc