RaftFleet.RecentlyRemovedGroups (raft_fleet v0.10.2) View Source
Link to this section Summary
Functions
Type-aware getter for active_nodes.
Type-aware setter for active_nodes.
Type-aware getter for group_to_indices.
Type-aware setter for group_to_indices.
Type-aware getter for index_to_group.
Type-aware setter for index_to_group.
Type-aware getter for max_index.
Type-aware setter for max_index.
Type-aware getter for min_index.
Type-aware setter for min_index.
Creates a new instance of RaftFleet.RecentlyRemovedGroups by using the given dict.
A variant of new/1 which returns t or raise if validation fails.
Updates an existing instance of RaftFleet.RecentlyRemovedGroups 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.RecentlyRemovedGroups{
active_nodes: RaftFleet.RecentlyRemovedGroups.NodesMap.t(),
group_to_indices: RaftFleet.RecentlyRemovedGroups.GroupNameToIndices.t(),
index_to_group: RaftFleet.RecentlyRemovedGroups.IndexToGroupName.t(),
max_index: Croma.TypeGen.Nilable.Croma.PosInteger.t(),
min_index: Croma.TypeGen.Nilable.Croma.PosInteger.t()
}
Link to this section Functions
Specs
active_nodes(t()) :: RaftFleet.RecentlyRemovedGroups.NodesMap.t()
Type-aware getter for active_nodes.
Specs
active_nodes(t(), RaftFleet.RecentlyRemovedGroups.NodesMap.t()) :: t()
Type-aware setter for active_nodes.
Specs
Specs
Specs
Specs
empty() :: t()
Specs
group_to_indices(t()) :: RaftFleet.RecentlyRemovedGroups.GroupNameToIndices.t()
Type-aware getter for group_to_indices.
Specs
group_to_indices(t(), RaftFleet.RecentlyRemovedGroups.GroupNameToIndices.t()) :: t()
Type-aware setter for group_to_indices.
Specs
index_to_group(t()) :: RaftFleet.RecentlyRemovedGroups.IndexToGroupName.t()
Type-aware getter for index_to_group.
Specs
index_to_group(t(), RaftFleet.RecentlyRemovedGroups.IndexToGroupName.t()) :: t()
Type-aware setter for index_to_group.
Specs
max_index(t()) :: Croma.TypeGen.Nilable.Croma.PosInteger.t()
Type-aware getter for max_index.
Specs
Type-aware setter for max_index.
Specs
min_index(t()) :: Croma.TypeGen.Nilable.Croma.PosInteger.t()
Type-aware getter for min_index.
Specs
Type-aware setter for min_index.
Specs
names_for_node(t(), node()) :: {[atom()], nil | pos_integer()}
Specs
new(term()) :: Croma.Result.t(t())
Creates a new instance of RaftFleet.RecentlyRemovedGroups 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
update(t(), Dict.t()) :: Croma.Result.t(t())
Updates an existing instance of RaftFleet.RecentlyRemovedGroups 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
update( t(), RaftFleet.NodesPerZone.t(), node(), nil | pos_integer(), pos_integer(), pos_integer() ) :: t()
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.