View Source AntikytheraCore.PeriodicLog.Writer.State (antikythera v0.5.1)
Summary
Functions
Type-aware getter for build_mod.
Type-aware setter for build_mod.
Type-aware getter for build_state.
Type-aware setter for build_state.
Type-aware getter for log_state.
Type-aware setter for log_state.
Creates a new instance of AntikytheraCore.PeriodicLog.Writer.State by using the given dict.
A variant of new/1 which returns t or raise if validation fails.
Updates an existing instance of AntikytheraCore.PeriodicLog.Writer.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
@type t() :: %AntikytheraCore.PeriodicLog.Writer.State{ build_mod: Croma.Atom.t(), build_state: Croma.Any.t(), log_state: AntikytheraCore.GearLog.LogRotation.State.t() }
Functions
@spec build_mod(t()) :: Croma.Atom.t()
Type-aware getter for build_mod.
@spec build_mod(t(), Croma.Atom.t()) :: t()
Type-aware setter for build_mod.
@spec build_state(t()) :: Croma.Any.t()
Type-aware getter for build_state.
@spec build_state(t(), Croma.Any.t()) :: t()
Type-aware setter for build_state.
@spec log_state(t()) :: AntikytheraCore.GearLog.LogRotation.State.t()
Type-aware getter for log_state.
@spec log_state(t(), AntikytheraCore.GearLog.LogRotation.State.t()) :: t()
Type-aware setter for log_state.
@spec new(term()) :: Croma.Result.t(t())
Creates a new instance of AntikytheraCore.PeriodicLog.Writer.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/0of each field typenew/1of 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.
@spec update(t(), Dict.t()) :: Croma.Result.t(t())
Updates an existing instance of AntikytheraCore.PeriodicLog.Writer.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.