rafted_value v0.11.1 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()
View Source
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()
}
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(state)
View Source
command_results(t()) :: RaftedValue.CommandResults.t()
command_results(t()) :: RaftedValue.CommandResults.t()
Type-aware getter for command_results.
command_results(s, field)
View Source
command_results(t(), RaftedValue.CommandResults.t()) :: t()
command_results(t(), RaftedValue.CommandResults.t()) :: t()
Type-aware setter for command_results.
config(state)
View Source
config(t()) :: RaftedValue.Config.t()
config(t()) :: RaftedValue.Config.t()
Type-aware getter for config.
config(s, field)
View Source
config(t(), RaftedValue.Config.t()) :: t()
config(t(), RaftedValue.Config.t()) :: t()
Type-aware setter for config.
current_term(state)
View Source
current_term(t()) :: RaftedValue.TermNumber.t()
current_term(t()) :: RaftedValue.TermNumber.t()
Type-aware getter for current_term.
current_term(s, field)
View Source
current_term(t(), RaftedValue.TermNumber.t()) :: t()
current_term(t(), RaftedValue.TermNumber.t()) :: t()
Type-aware setter for current_term.
data(state)
View Source
data(t()) :: Croma.Any.t()
data(t()) :: Croma.Any.t()
Type-aware getter for data.
data(s, field)
View Source
data(t(), Croma.Any.t()) :: t()
data(t(), Croma.Any.t()) :: t()
Type-aware setter for data.
election(state)
View Source
election(t()) :: RaftedValue.Election.t()
election(t()) :: RaftedValue.Election.t()
Type-aware getter for election.
election(s, field)
View Source
election(t(), RaftedValue.Election.t()) :: t()
election(t(), RaftedValue.Election.t()) :: t()
Type-aware setter for election.
leadership(state)
View Source
leadership(t()) :: Croma.TypeGen.Nilable.RaftedValue.Leadership.t()
leadership(t()) :: Croma.TypeGen.Nilable.RaftedValue.Leadership.t()
Type-aware getter for leadership.
leadership(s, field) View Source
Type-aware setter for leadership.
logs(state)
View Source
logs(t()) :: RaftedValue.Logs.t()
logs(t()) :: RaftedValue.Logs.t()
Type-aware getter for logs.
logs(s, field)
View Source
logs(t(), RaftedValue.Logs.t()) :: t()
logs(t(), RaftedValue.Logs.t()) :: t()
Type-aware setter for logs.
members(state)
View Source
members(t()) :: RaftedValue.Members.t()
members(t()) :: RaftedValue.Members.t()
Type-aware getter for members.
members(s, field)
View Source
members(t(), RaftedValue.Members.t()) :: t()
members(t(), RaftedValue.Members.t()) :: t()
Type-aware setter for members.
new(dict)
View Source
new(term()) :: Croma.Result.t(t())
new(term()) :: Croma.Result.t(t())
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.
new!(dict) View Source
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(state)
View Source
persistence(t()) :: Croma.TypeGen.Nilable.RaftedValue.Persistence.t()
persistence(t()) :: Croma.TypeGen.Nilable.RaftedValue.Persistence.t()
Type-aware getter for persistence.
persistence(s, field) View Source
Type-aware setter for persistence.
update(s, dict)
View Source
update(t(), Dict.t()) :: Croma.Result.t(t())
update(t(), Dict.t()) :: Croma.Result.t(t())
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}
.
update!(s, dict) View Source
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) View Source
Checks if the given value belongs to t/0
or not.