RaftFleet.NodeReconnector.State (raft_fleet v0.10.2) View Source
Link to this section Summary
Functions
Creates a new instance of RaftFleet.NodeReconnector.State by using the given dict.
A variant of new/1 which returns t or raise if validation fails.
Type-aware getter for other_active_nodes.
Type-aware setter for other_active_nodes.
Type-aware getter for this_node_active?.
Type-aware setter for this_node_active?.
Type-aware getter for unhealthy_since.
Type-aware setter for unhealthy_since.
Updates an existing instance of RaftFleet.NodeReconnector.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() :: %RaftFleet.NodeReconnector.State{
other_active_nodes: Croma.TypeGen.ListOf.Croma.Atom.t(),
this_node_active?: Croma.Boolean.t(),
unhealthy_since: Croma.Map.t()
}
Link to this section Functions
Specs
new(term()) :: Croma.Result.t(t())
Creates a new instance of RaftFleet.NodeReconnector.State by using the given dict.
Values associated with the struct field names are fetched from the given dict
and then validated/converted with valid?/1/new/1.
For missing fields default values (if any) are used.
Returns {:ok, valid_struct} when all fields are filled with valid values.
Returns {:error, reason} if any error occurs (invalid value or no value is available).
See also moduledoc of Croma.Struct.
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
other_active_nodes(t()) :: Croma.TypeGen.ListOf.Croma.Atom.t()
Type-aware getter for other_active_nodes.
Specs
Type-aware setter for other_active_nodes.
Specs
Specs
Specs
Specs
this_node_active?(t()) :: Croma.Boolean.t()
Type-aware getter for this_node_active?.
Specs
this_node_active?(t(), Croma.Boolean.t()) :: t()
Type-aware setter for this_node_active?.
Specs
Specs
unhealthy_since(t()) :: Croma.Map.t()
Type-aware getter for unhealthy_since.
Specs
unhealthy_since(t(), Croma.Map.t()) :: t()
Type-aware setter for unhealthy_since.
Specs
update(t(), Dict.t()) :: Croma.Result.t(t())
Updates an existing instance of RaftFleet.NodeReconnector.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
update_active_nodes(t(), RaftFleet.NodesPerZone.t()) :: t()
Specs
Checks if the given value belongs to t/0 or not.