RaftFleet.NodeReconnector.State (raft_fleet v0.11.0)

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

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.

update_active_nodes(state, nodes_per_zone)

valid?(value)

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

Types

t()

@type t() :: %RaftFleet.NodeReconnector.State{
  other_active_nodes: Croma.TypeGen.ListOf.Croma.Atom.t(),
  this_node_active?: Croma.Boolean.t(),
  unhealthy_since: Croma.Map.t()
}

Functions

new(dict)

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

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.

other_active_nodes(state)

@spec other_active_nodes(t()) :: Croma.TypeGen.ListOf.Croma.Atom.t()

Type-aware getter for other_active_nodes.

other_active_nodes(s, field)

@spec other_active_nodes(t(), Croma.TypeGen.ListOf.Croma.Atom.t()) :: t()

Type-aware setter for other_active_nodes.

other_node_activated(state, node)

@spec other_node_activated(t(), node()) :: t()

refresh(state)

@spec refresh(t()) :: t()

this_node_activated(state)

@spec this_node_activated(t()) :: t()

this_node_active?(state)

@spec this_node_active?(t()) :: Croma.Boolean.t()

Type-aware getter for this_node_active?.

this_node_active?(s, field)

@spec this_node_active?(t(), Croma.Boolean.t()) :: t()

Type-aware setter for this_node_active?.

this_node_deactivated(state)

@spec this_node_deactivated(t()) :: t()

unhealthy_since(state)

@spec unhealthy_since(t()) :: Croma.Map.t()

Type-aware getter for unhealthy_since.

unhealthy_since(s, field)

@spec unhealthy_since(t(), Croma.Map.t()) :: t()

Type-aware setter for unhealthy_since.

unreachable_nodes(state)

update(s, dict)

@spec update(t(), Dict.t()) :: Croma.Result.t(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.

update_active_nodes(state, nodes_per_zone)

@spec update_active_nodes(t(), RaftFleet.NodesPerZone.t()) :: t()

valid?(value)

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

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