Module clique_config

Data Types

cuttlefish_flag_list() = [undefined | cuttlefish_flag_spec()]

cuttlefish_flag_spec() = {flag, atom(), atom()}

envkey() = {string(), {atom(), atom()}}

err() = {error, term()}

flagspecs() = [spec()]

proplist() = [{atom(), term()}]

config_flags/0
describe/2
do_set/1
get_local_env_status/2
get_local_env_vals/2
init/0
load_schema/1	Load Schemas into ets when given directories containing the *.schema files.
register/2	Register configuration callbacks for a given config key.
register_formatter/2	Register a pretty-print function for a given config key.
set/2
show/2
teardown/0
whitelist/1	Whitelist settable cuttlefish variables.

config_flags() -> flagspecs()

describe(Args::[string()], Flags::proplist()) -> clique_status:status() | err()

do_set(Args) -> any()

get_local_env_status(EnvKeys::[envkey()], CuttlefishFlags::cuttlefish_flag_list()) -> status()

get_local_env_vals(EnvKeys::[envkey()], CuttlefishFlags::cuttlefish_flag_list()) -> list()

init() -> any()

load_schema(Directories::[string()]) -> ok | {error, schema_files_not_found}

Load Schemas into ets when given directories containing the *.schema files. Note that this must be run before any registrations are made.

register(Key::[string()], Callback::function()) -> true

register_formatter(Key::[string()], Callback::function()) -> true

show(Args::[string()], Flags::proplist()) -> clique_status:status() | err()

teardown() -> ok

whitelist(Keys::[string()]) -> ok | {error, {invalid_config_keys, [string()]}}

Whitelist settable cuttlefish variables. By default all variables are not settable.

Generated by EDoc