Lamina.Server.ConfigValue (lamina v0.4.4)

Copy Markdown

A wrapper around an individual configuration value.

It makes the code much simpler. That is all.

Summary

Types

config_key()
lifetime()
provider()
provider_index()
t()

Functions

cast(config_value)

Perform a value cast using the ConfigValue's module.

expired?(config_value)

Has the ConfigValue expired?

init(config_key, lifetime, module, provider, provider_index, value)

Initialise a new ConfigValue.

validate(config_value)

Perform a value validation using the ConfigValue's module.

Types

config_key()

@type config_key() :: atom()

lifetime()

@type lifetime() :: Lamina.Provider.lifetime()

provider()

@type provider() :: module()

provider_index()

@type provider_index() :: pos_integer()

t()

@type t() :: %Lamina.Server.ConfigValue{
  config_key: atom(),
  expires_at: nil | pos_integer(),
  lifetime: lifetime(),
  module: module(),
  provider: module(),
  provider_index: pos_integer(),
  value: any()
}

Functions

cast(config_value)

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

Perform a value cast using the ConfigValue's module.

expired?(config_value)

@spec expired?(t()) :: boolean()

Has the ConfigValue expired?

init(config_key, lifetime, module, provider, provider_index, value)

@spec init(config_key(), lifetime(), module(), provider(), provider_index(), any()) ::
  {:ok, t()} | {:error, Exception.t()}

Initialise a new ConfigValue.

validate(config_value)

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

Perform a value validation using the ConfigValue's module.