rafted_value v0.11.1 RaftedValue.Snapshot 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 data.
Type-aware setter for data.
Type-aware getter for last_committed_entry.
Type-aware setter for last_committed_entry.
Type-aware getter for members.
Type-aware setter for members.
Creates a new instance of RaftedValue.Snapshot by using the given dict
.
A variant of new/1
which returns t
or raise if validation fails.
Type-aware getter for term.
Type-aware setter for term.
Updates an existing instance of RaftedValue.Snapshot 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.Snapshot{
command_results: RaftedValue.CommandResults.t(),
config: RaftedValue.Config.t(),
data: Croma.Any.t(),
last_committed_entry: RaftedValue.LogEntry.t(),
members: RaftedValue.Members.t(),
term: RaftedValue.TermNumber.t()
}
t() :: %RaftedValue.Snapshot{ command_results: RaftedValue.CommandResults.t(), config: RaftedValue.Config.t(), data: Croma.Any.t(), last_committed_entry: RaftedValue.LogEntry.t(), members: RaftedValue.Members.t(), term: RaftedValue.TermNumber.t() }
Link to this section Functions
command_results(snapshot)
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(snapshot)
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.
data(snapshot)
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.
decode(bin) View Source
encode(snapshot) View Source
from_install_snapshot(is)
View Source
from_install_snapshot(RaftedValue.RPC.InstallSnapshot.t()) :: t()
from_install_snapshot(RaftedValue.RPC.InstallSnapshot.t()) :: t()
last_committed_entry(snapshot)
View Source
last_committed_entry(t()) :: RaftedValue.LogEntry.t()
last_committed_entry(t()) :: RaftedValue.LogEntry.t()
Type-aware getter for last_committed_entry.
last_committed_entry(s, field)
View Source
last_committed_entry(t(), RaftedValue.LogEntry.t()) :: t()
last_committed_entry(t(), RaftedValue.LogEntry.t()) :: t()
Type-aware setter for last_committed_entry.
members(snapshot)
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.Snapshot 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
.
read_latest_snapshot_and_logs_if_available(dir)
View Source
read_latest_snapshot_and_logs_if_available(Path.t()) ::
nil
| {t(), RaftedValue.Persistence.SnapshotMetadata.t(),
Enum.t(RaftedValue.LogEntry.t())}
read_latest_snapshot_and_logs_if_available(Path.t()) :: nil | {t(), RaftedValue.Persistence.SnapshotMetadata.t(), Enum.t(RaftedValue.LogEntry.t())}
term(snapshot)
View Source
term(t()) :: RaftedValue.TermNumber.t()
term(t()) :: RaftedValue.TermNumber.t()
Type-aware getter for term.
term(s, field)
View Source
term(t(), RaftedValue.TermNumber.t()) :: t()
term(t(), RaftedValue.TermNumber.t()) :: t()
Type-aware setter for term.
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.Snapshot 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.