rafted_value v0.11.1 RaftedValue.Persistence View Source
Link to this section Summary
Functions
Type-aware getter for dir.
Type-aware setter for dir.
Type-aware getter for latest_snapshot_metadata.
Type-aware setter for latest_snapshot_metadata.
Type-aware getter for log_expansion_factor.
Type-aware setter for log_expansion_factor.
Type-aware getter for log_fd.
Type-aware setter for log_fd.
Type-aware getter for log_size_written.
Type-aware setter for log_size_written.
Creates a new instance of RaftedValue.Persistence by using the given dict
.
A variant of new/1
which returns t
or raise if validation fails.
Type-aware getter for snapshot_writer.
Type-aware setter for snapshot_writer.
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}
.
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.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()
}
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() }
Link to this section Functions
dir(persistence)
View Source
dir(t()) :: Croma.String.t()
dir(t()) :: Croma.String.t()
Type-aware getter for dir.
dir(s, field)
View Source
dir(t(), Croma.String.t()) :: t()
dir(t(), Croma.String.t()) :: t()
Type-aware setter for dir.
find_log_files_containing_uncommitted_entries(dir, i_committed)
View Source
find_log_files_containing_uncommitted_entries(
Path.t(),
RaftedValue.LogIndex.t()
) :: [Path.t()]
find_log_files_containing_uncommitted_entries( Path.t(), RaftedValue.LogIndex.t() ) :: [Path.t()]
latest_snapshot_metadata(persistence)
View Source
latest_snapshot_metadata(t()) ::
Croma.TypeGen.Nilable.RaftedValue.Persistence.SnapshotMetadata.t()
latest_snapshot_metadata(t()) :: Croma.TypeGen.Nilable.RaftedValue.Persistence.SnapshotMetadata.t()
Type-aware getter for latest_snapshot_metadata.
latest_snapshot_metadata(s, field) View Source
Type-aware setter for latest_snapshot_metadata.
list_snapshots_in(dir) View Source
log_compaction_runnable?(arg0)
View Source
log_compaction_runnable?(RaftedValue.Persistence.t()) :: boolean()
log_compaction_runnable?(RaftedValue.Persistence.t()) :: boolean()
log_expansion_factor(persistence)
View Source
log_expansion_factor(t()) :: Croma.Number.t()
log_expansion_factor(t()) :: Croma.Number.t()
Type-aware getter for log_expansion_factor.
log_expansion_factor(s, field)
View Source
log_expansion_factor(t(), Croma.Number.t()) :: t()
log_expansion_factor(t(), Croma.Number.t()) :: t()
Type-aware setter for log_expansion_factor.
log_fd(persistence)
View Source
log_fd(t()) :: Croma.TypeGen.Nilable.Croma.Tuple.t()
log_fd(t()) :: Croma.TypeGen.Nilable.Croma.Tuple.t()
Type-aware getter for log_fd.
log_fd(s, field)
View Source
log_fd(t(), Croma.TypeGen.Nilable.Croma.Tuple.t()) :: t()
log_fd(t(), Croma.TypeGen.Nilable.Croma.Tuple.t()) :: t()
Type-aware setter for log_fd.
log_size_written(persistence)
View Source
log_size_written(t()) :: Croma.NonNegInteger.t()
log_size_written(t()) :: Croma.NonNegInteger.t()
Type-aware getter for log_size_written.
log_size_written(s, field)
View Source
log_size_written(t(), Croma.NonNegInteger.t()) :: t()
log_size_written(t(), Croma.NonNegInteger.t()) :: t()
Type-aware setter for log_size_written.
new(dict)
View Source
new(term()) :: Croma.Result.t(t())
new(term()) :: Croma.Result.t(t())
Creates a new instance of RaftedValue.Persistence 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
.
new_with_disk_snapshot(dir, factor, meta, entry_restore)
View Source
new_with_disk_snapshot(
Path.t(),
number(),
RaftedValue.Persistence.SnapshotMetadata.t(),
RaftedValue.LogEntry.t()
) :: t()
new_with_disk_snapshot( Path.t(), number(), RaftedValue.Persistence.SnapshotMetadata.t(), RaftedValue.LogEntry.t() ) :: t()
new_with_initial_snapshotting(dir, factor, snapshot)
View Source
new_with_initial_snapshotting(Path.t(), number(), RaftedValue.Snapshot.t()) ::
t()
new_with_initial_snapshotting(Path.t(), number(), RaftedValue.Snapshot.t()) :: t()
new_with_snapshot_sent_from_leader(dir, factor, snapshot)
View Source
new_with_snapshot_sent_from_leader(Path.t(), number(), RaftedValue.Snapshot.t()) ::
t()
new_with_snapshot_sent_from_leader(Path.t(), number(), RaftedValue.Snapshot.t()) :: t()
read_last_log_index(dir)
View Source
read_last_log_index(Path.t()) :: nil | RaftedValue.LogIndex.t()
read_last_log_index(Path.t()) :: nil | RaftedValue.LogIndex.t()
snapshot_writer(persistence)
View Source
snapshot_writer(t()) :: Croma.TypeGen.Nilable.Croma.Pid.t()
snapshot_writer(t()) :: Croma.TypeGen.Nilable.Croma.Pid.t()
Type-aware getter for snapshot_writer.
snapshot_writer(s, field)
View Source
snapshot_writer(t(), Croma.TypeGen.Nilable.Croma.Pid.t()) :: t()
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)
View Source
switch_log_file_and_spawn_snapshot_writer(
RaftedValue.Persistence.t(),
RaftedValue.Snapshot.t(),
RaftedValue.LogIndex.t()
) :: t()
switch_log_file_and_spawn_snapshot_writer( RaftedValue.Persistence.t(), RaftedValue.Snapshot.t(), RaftedValue.LogIndex.t() ) :: t()
unset_snapshot_metadata(p) View Source
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.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) 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.
write_log_entries(p, entries)
View Source
write_log_entries(RaftedValue.Persistence.t(), [RaftedValue.LogEntry.t()]) ::
t()
write_log_entries(RaftedValue.Persistence.t(), [RaftedValue.LogEntry.t()]) :: t()