View Source AntikytheraCore.Config.Gear (antikythera v0.5.1)
Summary
Functions
Type-aware getter for alerts.
Type-aware setter for alerts.
Type-aware getter for domains.
Type-aware setter for domains.
Type-aware getter for internal_kv.
Type-aware setter for internal_kv.
Type-aware getter for kv.
Type-aware setter for kv.
Type-aware getter for log_level.
Type-aware setter for log_level.
Creates a new instance of AntikytheraCore.Config.Gear by using the given dict.
A variant of new/1 which returns t or raise if validation fails.
Updates an existing instance of AntikytheraCore.Config.Gear with the given dict.
The values in the dict are validated by each field's valid?/1 function.
Returns {:ok, valid_struct} or {:error, reason}.
A variant of update/2 which returns t or raise if validation fails.
In other words, update/2 followed by Croma.Result.get!/1.
Checks if the given value belongs to t/0 or not.
Types
@type t() :: %AntikytheraCore.Config.Gear{ alerts: AntikytheraCore.Alert.HandlerConfigsMap.t(), domains: AntikytheraCore.Config.Gear.CustomDomainList.t(), internal_kv: Croma.Map.t(), kv: Croma.Map.t(), log_level: AntikytheraCore.GearLog.Level.t() }
Functions
@spec alerts(t()) :: AntikytheraCore.Alert.HandlerConfigsMap.t()
Type-aware getter for alerts.
@spec alerts(t(), AntikytheraCore.Alert.HandlerConfigsMap.t()) :: t()
Type-aware setter for alerts.
@spec default() :: t()
@spec domains(t()) :: AntikytheraCore.Config.Gear.CustomDomainList.t()
Type-aware getter for domains.
@spec domains(t(), AntikytheraCore.Config.Gear.CustomDomainList.t()) :: t()
Type-aware setter for domains.
@spec dump_all_from_env_to_file() :: :ok
@spec ensure_loaded(Antikythera.GearName.t()) :: :ok
@spec internal_kv(t()) :: Croma.Map.t()
Type-aware getter for internal_kv.
@spec internal_kv(t(), Croma.Map.t()) :: t()
Type-aware setter for internal_kv.
@spec kv(t()) :: Croma.Map.t()
Type-aware getter for kv.
@spec kv(t(), Croma.Map.t()) :: t()
Type-aware setter for kv.
@spec load_all(Antikythera.SecondsSinceEpoch.t()) :: :ok
@spec log_level(t()) :: AntikytheraCore.GearLog.Level.t()
Type-aware getter for log_level.
@spec log_level(t(), AntikytheraCore.GearLog.Level.t()) :: t()
Type-aware setter for log_level.
@spec new(term()) :: Croma.Result.t(t())
Creates a new instance of AntikytheraCore.Config.Gear by using the given dict.
Returns {:ok, valid_struct} or {:error, reason}.
The values in the dict are validated by each field's valid?/1 function.
If the value was invalid, it will be passed to new/1 of the field
For missing fields, followings will be tried:
A variant of new/1 which returns t or raise if validation fails.
In other words, new/1 followed by Croma.Result.get!/1.
@spec read(Antikythera.GearName.t()) :: t()
@spec update(t(), Dict.t()) :: Croma.Result.t(t())
Updates an existing instance of AntikytheraCore.Config.Gear with the given dict.
The values in the dict are validated by each field's valid?/1 function.
Returns {:ok, valid_struct} or {:error, reason}.
A variant of update/2 which returns t or raise if validation fails.
In other words, update/2 followed by Croma.Result.get!/1.
Checks if the given value belongs to t/0 or not.
@spec write(Antikythera.GearName.t(), t()) :: :ok