View Source AntikytheraCore.ErrorCountsAccumulator.State (antikythera v0.5.1)

Summary

Functions

Type-aware getter for counts.

Type-aware setter for counts.

Creates a new instance of AntikytheraCore.ErrorCountsAccumulator.State by using the given dict.

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

Type-aware getter for now_minute.

Type-aware setter for now_minute.

Updates an existing instance of AntikytheraCore.ErrorCountsAccumulator.State 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

Functions

Link to this function

add(state, otp_app_name, count)

View Source
@spec add(
  t(),
  atom(),
  pos_integer()
) :: t()
Link to this function

advance_to_next_minute(arg0, now)

View Source
@spec advance_to_next_minute(
  t(),
  Antikythera.Time.t()
) :: t()

Type-aware getter for counts.

Type-aware setter for counts.

@spec get(
  t(),
  :antikythera | Antikythera.GearName.t()
) :: results()
@spec get_total(t()) :: results()
@spec new(term()) :: Croma.Result.t(t())

Creates a new instance of AntikytheraCore.ErrorCountsAccumulator.State 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
@spec new!(term()) :: t()

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 now_minute(t()) :: Antikythera.Time.t()

Type-aware getter for now_minute.

@spec now_minute(t(), Antikythera.Time.t()) :: t()

Type-aware setter for now_minute.

@spec update(t(), Dict.t()) :: Croma.Result.t(t())

Updates an existing instance of AntikytheraCore.ErrorCountsAccumulator.State 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}.

@spec 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.

@spec valid?(term()) :: boolean()

Checks if the given value belongs to t/0 or not.