antikythera v0.4.0 AntikytheraCore.GearLog.LogRotation.State View Source
Link to this section Summary
Functions
Type-aware getter for empty?.
Type-aware setter for empty?.
Type-aware getter for file_handle.
Type-aware setter for file_handle.
Type-aware getter for interval.
Type-aware setter for interval.
Creates a new instance of AntikytheraCore.GearLog.LogRotation.State by using the given dict.
A variant of new/1 which returns t or raise if validation fails.
Type-aware getter for timer.
Type-aware setter for timer.
Updates an existing instance of AntikytheraCore.GearLog.LogRotation.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.
Link to this section Types
Specs
t() :: %AntikytheraCore.GearLog.LogRotation.State{
empty?: Croma.Boolean.t(),
file_handle: Croma.Tuple.t(),
interval: Croma.NonNegInteger.t(),
timer: Croma.Reference.t()
}
Link to this section Functions
Specs
empty?(t()) :: Croma.Boolean.t()
Type-aware getter for empty?.
Specs
empty?(t(), Croma.Boolean.t()) :: t()
Type-aware setter for empty?.
Specs
file_handle(t()) :: Croma.Tuple.t()
Type-aware getter for file_handle.
Specs
file_handle(t(), Croma.Tuple.t()) :: t()
Type-aware setter for file_handle.
Specs
interval(t()) :: Croma.NonNegInteger.t()
Type-aware getter for interval.
Specs
interval(t(), Croma.NonNegInteger.t()) :: t()
Type-aware setter for interval.
Specs
new(term()) :: Croma.Result.t(t())
Creates a new instance of AntikytheraCore.GearLog.LogRotation.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
Specs
A variant of new/1 which returns t or raise if validation fails.
In other words, new/1 followed by Croma.Result.get!/1.
Specs
timer(t()) :: Croma.Reference.t()
Type-aware getter for timer.
Specs
timer(t(), Croma.Reference.t()) :: t()
Type-aware setter for timer.
Specs
update(t(), Dict.t()) :: Croma.Result.t(t())
Updates an existing instance of AntikytheraCore.GearLog.LogRotation.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}.
Specs
A variant of update/2 which returns t or raise if validation fails.
In other words, update/2 followed by Croma.Result.get!/1.
Specs
Checks if the given value belongs to t/0 or not.