rafted_value v0.5.0 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 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.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(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.
Type-aware getter for data.
Type-aware setter for data.
from_install_snapshot(RaftedValue.RPC.InstallSnapshot.t) :: t
last_committed_entry(t) :: RaftedValue.LogEntry.t
Type-aware getter for last_committed_entry.
last_committed_entry(t, RaftedValue.LogEntry.t) :: t
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
.
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
.
read_lastest_snapshot_and_logs_if_available(Path.t) :: nil | {t, RaftedValue.Persistence.SnapshotMetadata.t, Enum.t(RaftedValue.LogEntry.t)}
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 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
.