antikythera v0.4.0 AntikytheraCore.ExecutorPool.AsyncJobBroker.State View Source
Link to this section Summary
Functions
Creates a new instance of AntikytheraCore.ExecutorPool.AsyncJobBroker.State by using the given dict
.
A variant of new/1
which returns t
or raise if validation fails.
Type-aware getter for phase.
Type-aware setter for phase.
Type-aware getter for pool_name.
Type-aware setter for pool_name.
Type-aware getter for queue_name.
Type-aware setter for queue_name.
Updates an existing instance of AntikytheraCore.ExecutorPool.AsyncJobBroker.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.ExecutorPool.AsyncJobBroker.State{ phase: AntikytheraCore.ExecutorPool.AsyncJobBroker.Phase.t(), pool_name: Croma.Atom.t(), queue_name: Croma.Atom.t() }
Link to this section Functions
Specs
new(term()) :: Croma.Result.t(t())
Creates a new instance of AntikytheraCore.ExecutorPool.AsyncJobBroker.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
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
phase(t()) :: AntikytheraCore.ExecutorPool.AsyncJobBroker.Phase.t()
Type-aware getter for phase.
Specs
phase(t(), AntikytheraCore.ExecutorPool.AsyncJobBroker.Phase.t()) :: t()
Type-aware setter for phase.
Specs
pool_name(t()) :: Croma.Atom.t()
Type-aware getter for pool_name.
Specs
pool_name(t(), Croma.Atom.t()) :: t()
Type-aware setter for pool_name.
Specs
queue_name(t()) :: Croma.Atom.t()
Type-aware getter for queue_name.
Specs
queue_name(t(), Croma.Atom.t()) :: t()
Type-aware setter for queue_name.
Specs
update(t(), Dict.t()) :: Croma.Result.t(t())
Updates an existing instance of AntikytheraCore.ExecutorPool.AsyncJobBroker.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.