rafted_value v0.10.3 RaftedValue.Server.State View Source
Link to this section Summary
Functions
Type-aware getter for command_results
Type-aware setter for command_results
Type-aware getter for config
Type-aware setter for config
Type-aware getter for current_term
Type-aware setter for current_term
Type-aware getter for data
Type-aware setter for data
Type-aware getter for election
Type-aware setter for election
Type-aware getter for leadership
Type-aware setter for leadership
Type-aware getter for logs
Type-aware setter for logs
Type-aware getter for members
Type-aware setter for members
Creates a new instance of RaftedValue.Server.State by using the given dict
A variant of new/1
which returns t
or raise if validation fails
Type-aware getter for persistence
Type-aware setter for persistence
Updates an existing instance of RaftedValue.Server.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}
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
t() :: %RaftedValue.Server.State{ command_results: RaftedValue.CommandResults.t(), config: RaftedValue.Config.t(), current_term: RaftedValue.TermNumber.t(), data: Croma.Any.t(), election: RaftedValue.Election.t(), leadership: Croma.TypeGen.Nilable.RaftedValue.Leadership.t(), logs: RaftedValue.Logs.t(), members: RaftedValue.Members.t(), persistence: Croma.TypeGen.Nilable.RaftedValue.Persistence.t() }
Link to this section Functions
command_results(t()) :: RaftedValue.CommandResults.t()
Type-aware getter for command_results.
command_results(t(), RaftedValue.CommandResults.t()) :: t()
Type-aware setter for command_results.
Type-aware getter for config.
Type-aware setter for config.
current_term(t()) :: RaftedValue.TermNumber.t()
Type-aware getter for current_term.
current_term(t(), RaftedValue.TermNumber.t()) :: t()
Type-aware setter for current_term.
Type-aware getter for data.
Type-aware setter for data.
Type-aware getter for election.
Type-aware setter for election.
leadership(t()) :: Croma.TypeGen.Nilable.RaftedValue.Leadership.t()
Type-aware getter for leadership.
Type-aware setter for leadership.
Type-aware getter for logs.
Type-aware setter for logs.
Type-aware getter for members.
Type-aware setter for members.
Creates a new instance of RaftedValue.Server.State 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 valid?/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
.
persistence(t()) :: Croma.TypeGen.Nilable.RaftedValue.Persistence.t()
Type-aware getter for persistence.
Type-aware setter for persistence.
Updates an existing instance of RaftedValue.Server.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}
.
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.