rafted_value v0.7.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 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

Link to this type 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()}

Link to this section Functions

Link to this function command_results(snapshot) View Source
command_results(t()) :: RaftedValue.CommandResults.t()

Type-aware getter for command_results.

Link to this function command_results(s, field) View Source
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.

Link to this function data(s, field) View Source
data(t(), Croma.Any.t()) :: t()

Type-aware setter for data.

Link to this function decode(bin) View Source
decode(binary()) :: Snapshot.t()
Link to this function encode(snapshot) View Source
encode(Snapshot.t()) :: binary()
Link to this function from_install_snapshot(is) View Source
from_install_snapshot(RaftedValue.RPC.InstallSnapshot.t()) :: t()
Link to this function last_committed_entry(snapshot) View Source
last_committed_entry(t()) :: RaftedValue.LogEntry.t()

Type-aware getter for last_committed_entry.

Link to this function last_committed_entry(s, field) View Source
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 valid?/1 function.

Link to this function new!(dict) View Source
new!(term()) :: t()

A variant of new/1 which returns t or raise if validation fails.

In other words, new/1 followed by Croma.Result.get!/1.

Link to this function read_lastest_snapshot_and_logs_if_available(dir) View Source
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 valid?/1 function. Returns {:ok, valid_struct} or {:error, reason}.

Link to this function update!(s, dict) View Source
update!(t(), Dict.t()) :: t()

A variant of update/2 which returns t or raise if validation fails. In other words, update/2 followed by Croma.Result.get!/1.

Link to this function valid?(value) View Source
valid?(term()) :: boolean()

Checks if the given value belongs to t/0 or not.