rafted_value v0.1.1 RaftedValue.Members
Summary
Functions
Type-aware getter for all
Type-aware setter for all
Type-aware getter for leader
Type-aware setter for leader
Creates a new instance of Elixir.RaftedValue.Members by using the given dict
and the default value of each field.
Returns {:ok, valid_struct}
or {:error, reason}
.
The values in the dict
are validated by each field’s validate/1
function
Type-aware getter for pending_leader_change
Type-aware setter for pending_leader_change
Type-aware getter for uncommitted_membership_change
Type-aware setter for uncommitted_membership_change
Updates an existing instance of Elixir.RaftedValue.Members with the given dict
.
The values in the dict
are validated by each field’s validate/1
function.
Returns {:ok, valid_struct}
or {:error, reason}
Checks that the given dict
is valid or not by using each field’s validate/1
function.
Returns {:ok, valid_struct}
or {:error, reason}
A variant of validate/1
which returns t
or raise if validation fails.
In other words, validate/1
followed by Croma.Result.get!/1
Types
t :: %RaftedValue.Members{all: RaftedValue.PidSet.t, leader: Croma.TypeGen.Nilable.Croma.Pid.t, pending_leader_change: Croma.TypeGen.Nilable.Croma.Pid.t, uncommitted_membership_change: Croma.TypeGen.Nilable.RaftedValue.LogEntry.t}
Functions
Type-aware setter for leader.
Specs
membership_change_committed(RaftedValue.Members.t, LogIndex.t) :: t
Creates a new instance of Elixir.RaftedValue.Members by using the given dict
and the default value of each field.
Returns {:ok, valid_struct}
or {:error, reason}
.
The values in the dict
are validated by each field’s validate/1
function.
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
pending_leader_change(t) :: Croma.TypeGen.Nilable.Croma.Pid.t
Type-aware getter for pending_leader_change.
Type-aware setter for pending_leader_change.
Specs
start_adding_follower(RaftedValue.Members.t, {any, any, :add_follower, any}) :: Croma.Result.t(t)
Specs
start_removing_follower(RaftedValue.Members.t, {any, any, :remove_follower, any}) :: Croma.Result.t(t)
Specs
start_replacing_leader(RaftedValue.Members.t, nil | pid) :: Croma.Result.t(t)
Specs
uncommitted_membership_change(t) :: Croma.TypeGen.Nilable.RaftedValue.LogEntry.t
Type-aware getter for uncommitted_membership_change.
Type-aware setter for uncommitted_membership_change.
Updates an existing instance of Elixir.RaftedValue.Members with the given dict
.
The values in the dict
are validated by each field’s validate/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 that the given dict
is valid or not by using each field’s validate/1
function.
Returns {:ok, valid_struct}
or {:error, reason}
.
A variant of validate/1
which returns t
or raise if validation fails.
In other words, validate/1
followed by Croma.Result.get!/1
.