rafted_value v0.2.1 RaftedValue.Members View Source
Link to this section 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 RaftedValue.Members by using the given dict
A variant of new/1
which returns t
or raise if validation fails
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 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
Link to this section 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}
Link to this section Functions
Type-aware getter for all.
Type-aware setter for all.
force_remove_member(RaftedValue.Members.t, pid) :: t
Type-aware getter for leader.
leader(t, Croma.TypeGen.Nilable.Croma.Pid.t) :: t
Type-aware setter for leader.
membership_change_committed(RaftedValue.Members.t, LogIndex.t) :: t
Creates a new instance of RaftedValue.Members by using the given dict
.
For missing fields, default/0
of each field type will be used.
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
.
other_members_list(RaftedValue.Members.t) :: [pid]
pending_leader_change(t) :: Croma.TypeGen.Nilable.Croma.Pid.t
Type-aware getter for pending_leader_change.
pending_leader_change(t, Croma.TypeGen.Nilable.Croma.Pid.t) :: t
Type-aware setter for pending_leader_change.
start_adding_follower(RaftedValue.Members.t, {any, any, :add_follower, any}) :: Croma.Result.t(t)
start_removing_follower(RaftedValue.Members.t, {any, any, :remove_follower, any}) :: Croma.Result.t(t)
start_replacing_leader(RaftedValue.Members.t, nil | pid) :: Croma.Result.t(t)
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 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
.