RaftedValue.Persistence (rafted_value v0.12.0)

Updates an existing instance of RaftedValue.Persistence 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)

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)

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

write_log_entries(p, entries)

Types

t()

@type t() :: %RaftedValue.Persistence{
  dir: Croma.String.t(),
  latest_snapshot_metadata:
    Croma.TypeGen.Nilable.RaftedValue.Persistence.SnapshotMetadata.t(),
  log_expansion_factor: Croma.Number.t(),
  log_fd: Croma.TypeGen.Nilable.Croma.Tuple.t(),
  log_size_written: Croma.NonNegInteger.t(),
  snapshot_writer: Croma.TypeGen.Nilable.Croma.Pid.t()
}

Functions

dir(persistence)

@spec dir(t()) :: Croma.String.t()

Type-aware getter for dir.

dir(s, field)

@spec dir(t(), Croma.String.t()) :: t()

Type-aware setter for dir.

find_log_files_containing_uncommitted_entries(dir, i_committed)

@spec find_log_files_containing_uncommitted_entries(
  Path.t(),
  RaftedValue.LogIndex.t()
) :: [Path.t()]

latest_snapshot_metadata(persistence)

@spec latest_snapshot_metadata(t()) ::
  Croma.TypeGen.Nilable.RaftedValue.Persistence.SnapshotMetadata.t()

Type-aware getter for latest_snapshot_metadata.

latest_snapshot_metadata(s, field)

@spec latest_snapshot_metadata(
  t(),
  Croma.TypeGen.Nilable.RaftedValue.Persistence.SnapshotMetadata.t()
) ::
  t()

Type-aware setter for latest_snapshot_metadata.

list_snapshots_in(dir)

@spec list_snapshots_in(Path.t()) :: [Path.t()]

log_compaction_runnable?(arg0)

@spec log_compaction_runnable?(t()) :: boolean()

log_expansion_factor(persistence)

@spec log_expansion_factor(t()) :: Croma.Number.t()

Type-aware getter for log_expansion_factor.

log_expansion_factor(s, field)

@spec log_expansion_factor(t(), Croma.Number.t()) :: t()

Type-aware setter for log_expansion_factor.

log_fd(persistence)

@spec log_fd(t()) :: Croma.TypeGen.Nilable.Croma.Tuple.t()

Type-aware getter for log_fd.

log_fd(s, field)

@spec log_fd(t(), Croma.TypeGen.Nilable.Croma.Tuple.t()) :: t()

Type-aware setter for log_fd.

log_size_written(persistence)

@spec log_size_written(t()) :: Croma.NonNegInteger.t()

Type-aware getter for log_size_written.

log_size_written(s, field)

@spec log_size_written(t(), Croma.NonNegInteger.t()) :: t()

Type-aware setter for log_size_written.

new(dict)

@spec new(term()) :: Croma.Result.t(t())

Creates a new instance of RaftedValue.Persistence by using the given dict.

Values associated with the struct field names are fetched from the given dict and then validated/converted with valid?/1/new/1. For missing fields default values (if any) are used.

Returns {:ok, valid_struct} when all fields are filled with valid values. Returns {:error, reason} if any error occurs (invalid value or no value is available).

new!(dict)

@spec 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.

new_with_disk_snapshot(dir, factor, meta, entry_restore)

@spec new_with_disk_snapshot(
  Path.t(),
  number(),
  RaftedValue.Persistence.SnapshotMetadata.t(),
  RaftedValue.LogEntry.t()
) :: t()

new_with_initial_snapshotting(dir, factor, snapshot)

@spec new_with_initial_snapshotting(Path.t(), number(), RaftedValue.Snapshot.t()) ::
  t()

new_with_snapshot_sent_from_leader(dir, factor, snapshot)

@spec new_with_snapshot_sent_from_leader(Path.t(), number(), RaftedValue.Snapshot.t()) ::
  t()

read_last_log_index(dir)

@spec read_last_log_index(Path.t()) :: nil | RaftedValue.LogIndex.t()

snapshot_writer(persistence)

@spec snapshot_writer(t()) :: Croma.TypeGen.Nilable.Croma.Pid.t()

Type-aware getter for snapshot_writer.

snapshot_writer(s, field)

@spec snapshot_writer(t(), Croma.TypeGen.Nilable.Croma.Pid.t()) :: t()

Type-aware setter for snapshot_writer.

switch_log_file_and_spawn_snapshot_writer(persistence, snapshot, index_next)

@spec switch_log_file_and_spawn_snapshot_writer(
  t(),
  RaftedValue.Snapshot.t(),
  RaftedValue.LogIndex.t()
) :: t()

unset_snapshot_metadata(p)

@spec unset_snapshot_metadata(t()) :: t()

update(s, dict)

@spec update(t(), Dict.t()) :: Croma.Result.t(t())

update!(s, dict)

@spec 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.

valid?(value)

@spec valid?(term()) :: boolean()

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

write_log_entries(p, entries)

@spec write_log_entries(t(), [RaftedValue.LogEntry.t()]) :: t()