antikythera v0.2.0 AntikytheraCore.GearLog.Writer.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 min_level
Type-aware setter for min_level
Creates a new instance of AntikytheraCore.GearLog.Writer.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.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
Type-aware getter for uploader
Type-aware setter for uploader
Checks if the given value belongs to t/0
or not
Link to this section Types
t() :: %AntikytheraCore.GearLog.Writer.State{empty?: Croma.Boolean.t(), file_handle: Croma.Tuple.t(), min_level: AntikytheraCore.GearLog.Level.t(), timer: Croma.Reference.t(), uploader: Croma.TypeGen.Nilable.Croma.Pid.t()}
Link to this section Functions
Type-aware getter for empty?.
Type-aware setter for empty?.
Type-aware getter for file_handle.
Type-aware setter for file_handle.
min_level(t()) :: AntikytheraCore.GearLog.Level.t()
Type-aware getter for min_level.
min_level(t(), AntikytheraCore.GearLog.Level.t()) :: t()
Type-aware setter for min_level.
Creates a new instance of AntikytheraCore.GearLog.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/0
of each field typenew/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
.
Type-aware getter for timer.
Type-aware setter for timer.
Updates an existing instance of AntikytheraCore.GearLog.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
.
uploader(t()) :: Croma.TypeGen.Nilable.Croma.Pid.t()
Type-aware getter for uploader.
uploader(t(), Croma.TypeGen.Nilable.Croma.Pid.t()) :: t()
Type-aware setter for uploader.
Checks if the given value belongs to t/0
or not.