Foundation.Contracts.Configurable behaviour (foundation v0.1.0)

Behaviour contract for configuration providers.

Defines the interface that all configuration implementations must follow. Ensures consistent API across different configuration backends.

Summary

Types

config_path()
config_value()

Callbacks

available?()

Check if the configuration service is available.

get()

Get the complete configuration.

get(config_path)

Get a configuration value by path.

reset()

Reset configuration to defaults.

updatable_paths()

Get the list of paths that can be updated at runtime.

update(config_path, config_value)

Update a configuration value at the given path.

validate(t)

Validate a configuration structure.

Types

config_path()

@type config_path() :: [atom()]

config_value()

@type config_value() :: term()

Callbacks

available?()

@callback available?() :: boolean()

Check if the configuration service is available.

get()

@callback get() ::
  {:ok, Foundation.Types.Config.t()} | {:error, Foundation.Types.Error.t()}

Get the complete configuration.

get(config_path)

@callback get(config_path()) ::
  {:ok, config_value()} | {:error, Foundation.Types.Error.t()}

Get a configuration value by path.

reset()

@callback reset() :: :ok | {:error, Foundation.Types.Error.t()}

Reset configuration to defaults.

updatable_paths()

@callback updatable_paths() :: [config_path()]

Get the list of paths that can be updated at runtime.

update(config_path, config_value)

@callback update(config_path(), config_value()) ::
  :ok | {:error, Foundation.Types.Error.t()}

Update a configuration value at the given path.

validate(t)

@callback validate(Foundation.Types.Config.t()) ::
  :ok | {:error, Foundation.Types.Error.t()}

Validate a configuration structure.