Lamina.Server.ConfigModule (lamina v0.4.4)

Wrapper around access to a Lamina configuration module

Summary

Functions

assert_lamina_module(module)

Ensure that the module in question actually implements the Lamina behaviour.

cast(module, config_key, value)

Call the Lamina callback on the configuration module to cast a configuration value.

config_change(module, config_key, old_value, new_value)

Call the config_change/3 callback on the configuration module.

config_keys(module)

Call the Lamina callback on the configuration module and return a list of config keys.

providers(module)

Call the Lamina callback on the configuration module and return the providers.

validate(module, config_key, value)

Call the Lamina callback on the configuration module to validate a configuration value.

Functions

assert_lamina_module(module)

@spec assert_lamina_module(module()) ::
  {:ok, module()} | {:error, Lamina.Error.NotALaminaModuleError.t()}

Ensure that the module in question actually implements the Lamina behaviour.

cast(module, config_key, value)

@spec cast(module(), atom(), any()) :: {:ok, any()} | {:error, any()}

Call the Lamina callback on the configuration module to cast a configuration value.

config_change(module, config_key, old_value, new_value)

@spec config_change(module(), config_key, old_value, new_value) :: :ok | no_return()
when config_key: atom(), old_value: any(), new_value: any()

Call the config_change/3 callback on the configuration module.

config_keys(module)

@spec config_keys(module()) :: [atom()]

Call the Lamina callback on the configuration module and return a list of config keys.

providers(module)

@spec providers(module()) :: [{module(), keyword()}]

Call the Lamina callback on the configuration module and return the providers.

validate(module, config_key, value)

@spec validate(module(), atom(), any()) :: {:ok, any()} | {:error, any()}

Call the Lamina callback on the configuration module to validate a configuration value.