RaftFleet.RecentlyRemovedGroups (raft_fleet v0.11.0)

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}.

update(t, npz, node_from, index_or_nil, now, wait_time)

update!(s, dict)

A variant of update/2 which returns t or raise if validation fails. In other words, update/2 followed by Croma.Result.get!/1.

valid?(value)

Checks if the given value belongs to t/0 or not.

Types

t()

@type 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()
}

Functions

active_nodes(recently_removed_groups)

@spec active_nodes(t()) :: RaftFleet.RecentlyRemovedGroups.NodesMap.t()

Type-aware getter for active_nodes.

active_nodes(s, field)

@spec active_nodes(t(), RaftFleet.RecentlyRemovedGroups.NodesMap.t()) :: t()

Type-aware setter for active_nodes.

add(t, group)

@spec add(t(), atom()) :: t()

cancel(t, group)

@spec cancel(t(), atom()) :: t()

cleanup_ongoing?(arg0, group)

@spec cleanup_ongoing?(t(), atom()) :: boolean()

empty()

@spec empty() :: t()

group_to_indices(recently_removed_groups)

@spec group_to_indices(t()) :: RaftFleet.RecentlyRemovedGroups.GroupNameToIndices.t()

Type-aware getter for group_to_indices.

group_to_indices(s, field)

@spec group_to_indices(t(), RaftFleet.RecentlyRemovedGroups.GroupNameToIndices.t()) ::
  t()

Type-aware setter for group_to_indices.

index_to_group(recently_removed_groups)

@spec index_to_group(t()) :: RaftFleet.RecentlyRemovedGroups.IndexToGroupName.t()

Type-aware getter for index_to_group.

index_to_group(s, field)

@spec index_to_group(t(), RaftFleet.RecentlyRemovedGroups.IndexToGroupName.t()) :: t()

Type-aware setter for index_to_group.

max_index(recently_removed_groups)

@spec max_index(t()) :: Croma.TypeGen.Nilable.Croma.PosInteger.t()

Type-aware getter for max_index.

max_index(s, field)

@spec max_index(t(), Croma.TypeGen.Nilable.Croma.PosInteger.t()) :: t()

Type-aware setter for max_index.

min_index(recently_removed_groups)

@spec min_index(t()) :: Croma.TypeGen.Nilable.Croma.PosInteger.t()

Type-aware getter for min_index.

min_index(s, field)

@spec min_index(t(), Croma.TypeGen.Nilable.Croma.PosInteger.t()) :: t()

Type-aware setter for min_index.

names_for_node(arg0, node_from)

@spec names_for_node(t(), node()) :: {[atom()], nil | pos_integer()}

new(dict)

@spec 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).

new!(dict)

@spec new!(term()) :: t()

A variant of new/1 which returns t or raise if validation fails.

In other words, new/1 followed by Croma.Result.get!/1.

update(s, dict)

@spec update(t(), Dict.t()) :: Croma.Result.t(t())

update(t, npz, node_from, index_or_nil, now, wait_time)

@spec update(
  t(),
  RaftFleet.NodesPerZone.t(),
  node(),
  nil | pos_integer(),
  pos_integer(),
  pos_integer()
) :: t()

update!(s, dict)

@spec update!(t(), Dict.t()) :: t()

A variant of update/2 which returns t or raise if validation fails. In other words, update/2 followed by Croma.Result.get!/1.

valid?(value)

@spec valid?(term()) :: boolean()

Checks if the given value belongs to t/0 or not.