antikythera v0.2.0 AntikytheraCore.Handler.HelperModules View Source

Link to this section Summary

Functions

Type-aware getter for logger

Type-aware setter for logger

Type-aware getter for metrics_uploader

Type-aware setter for metrics_uploader

Creates a new instance of AntikytheraCore.Handler.HelperModules by using the given dict

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

Type-aware getter for router

Type-aware setter for router

Type-aware getter for top

Type-aware setter for top

Updates an existing instance of AntikytheraCore.Handler.HelperModules 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 type t() View Source
t() :: %AntikytheraCore.Handler.HelperModules{logger: Croma.Atom.t(), metrics_uploader: Croma.Atom.t(), router: Croma.Atom.t(), top: Croma.Atom.t()}

Link to this section Functions

Link to this function logger(helper_modules) View Source
logger(t()) :: Croma.Atom.t()

Type-aware getter for logger.

Link to this function logger(s, field) View Source
logger(t(), Croma.Atom.t()) :: t()

Type-aware setter for logger.

Link to this function metrics_uploader(helper_modules) View Source
metrics_uploader(t()) :: Croma.Atom.t()

Type-aware getter for metrics_uploader.

Link to this function metrics_uploader(s, field) View Source
metrics_uploader(t(), Croma.Atom.t()) :: t()

Type-aware setter for metrics_uploader.

Creates a new instance of AntikytheraCore.Handler.HelperModules 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.

Link to this function router(helper_modules) View Source
router(t()) :: Croma.Atom.t()

Type-aware getter for router.

Link to this function router(s, field) View Source
router(t(), Croma.Atom.t()) :: t()

Type-aware setter for router.

Link to this function top(helper_modules) View Source
top(t()) :: Croma.Atom.t()

Type-aware getter for top.

Type-aware setter for top.

Updates an existing instance of AntikytheraCore.Handler.HelperModules 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.