MscmpSystSettings.Types (mscmp_syst_settings v0.1.0)

Types used by Settings service module.

Summary

Types

service_name()

The valid forms of service name acceptable to identify the Settings service.

setting_name()

Identification of each unique Setting managed by the Settings Service instance.

setting_params()

A map definition describing what specific key/value pairs are available for passing as SystSettings changeset parameters.

setting_service_params()

The expected form of the parameters used to start the Settings service.

setting_types()

Data types of values accepted by any individual setting record. Note that any one setting record may set values for one or more of these types concurrently.

Types

service_name()

@type service_name() :: atom() | {:via, module(), atom() | {atom(), atom()}}

The valid forms of service name acceptable to identify the Settings service.

Currently we expect the service name to be an atom, though we expect that any of a simple local name, the :global registry, or the Registry module to be used for service registration. Any registry compatible with those options should also work.

setting_name()

@type setting_name() :: String.t()

Identification of each unique Setting managed by the Settings Service instance.

setting_params()

@type setting_params() :: %{
  optional(:internal_name) => setting_name(),
  optional(:display_name) => String.t(),
  optional(:user_description) => String.t(),
  optional(:setting_flag) => boolean(),
  optional(:setting_integer) => integer(),
  optional(:setting_integer_range) => MscmpSystDb.DbTypes.IntegerRange.t(),
  optional(:setting_decimal) => Decimal.t(),
  optional(:setting_decimal_range) => MscmpSystDb.DbTypes.DecimalRange.t(),
  optional(:setting_interval) => MscmpSystDb.DbTypes.Interval.t(),
  optional(:setting_date) => Date.t(),
  optional(:setting_date_range) => MscmpSystDb.DbTypes.DateRange.t(),
  optional(:setting_time) => Time.t(),
  optional(:setting_timestamp) => DateTime.t(),
  optional(:setting_timestamp_range) => MscmpSystDb.DbTypes.DateTimeRange.t(),
  optional(:setting_json) => map(),
  optional(:setting_text) => String.t(),
  optional(:setting_uuid) => Ecto.UUID.t(),
  optional(:setting_blob) => binary()
}

A map definition describing what specific key/value pairs are available for passing as SystSettings changeset parameters.

setting_service_params()

@type setting_service_params() :: {service_name(), MscmpSystDb.Types.context_name()}

The expected form of the parameters used to start the Settings service.

setting_types()

@type setting_types() ::
  :setting_flag
  | :setting_integer
  | :setting_integer_range
  | :setting_decimal
  | :setting_decimal_range
  | :setting_interval
  | :setting_date
  | :setting_date_range
  | :setting_time
  | :setting_timestamp
  | :setting_timestamp_range
  | :setting_json
  | :setting_text
  | :setting_uuid
  | :setting_blob

Data types of values accepted by any individual setting record. Note that any one setting record may set values for one or more of these types concurrently.