antikythera v0.2.0 AntikytheraCore.Config.Gear View Source

Link to this section 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 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

Link to this section Types

Link to this section Functions

Type-aware getter for alerts.

Type-aware setter for alerts.

Link to this function default() View Source
default() :: t()

Type-aware getter for domains.

Type-aware setter for domains.

Link to this function dump_all_from_env_to_file() View Source
dump_all_from_env_to_file() :: :ok
Link to this function ensure_loaded(gear_name) View Source
ensure_loaded(Antikythera.GearName.t()) :: :ok

Type-aware getter for kv.

Type-aware setter for kv.

Link to this function load_all(last_checked_at) View Source
load_all(Antikythera.SecondsSinceEpoch.t()) :: :ok

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.

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:

  • default/0 of each field type
  • new/1 of each field type, with empty map as input

A variant of new/1 which returns t or raise if validation fails.

In other words, new/1 followed by Croma.Result.get!/1.

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}.

Link to this function update!(s, dict) View Source
update!(t(), Dict.t()) :: t()

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.

Link to this function write(gear_name, config) View Source
write(Antikythera.GearName.t(), t()) :: :ok