rafted_value v0.3.1 RaftedValue.Persistence.SnapshotMetadata View Source

Link to this section Summary

Functions

Type-aware getter for last_committed_index

Type-aware setter for last_committed_index

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

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

Type-aware getter for path

Type-aware setter for path

Type-aware getter for size

Type-aware setter for size

Type-aware getter for term

Type-aware setter for term

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

Link to this type t() View Source
t() :: %RaftedValue.Persistence.SnapshotMetadata{last_committed_index: RaftedValue.LogIndex.t, path: Croma.String.t, size: Croma.PosInteger.t, term: RaftedValue.TermNumber.t}

Link to this section Functions

Link to this function last_committed_index(snapshot_metadata) View Source
last_committed_index(t) :: RaftedValue.LogIndex.t

Type-aware getter for last_committed_index.

Link to this function last_committed_index(s, field) View Source
last_committed_index(t, RaftedValue.LogIndex.t) :: t

Type-aware setter for last_committed_index.

Creates a new instance of RaftedValue.Persistence.SnapshotMetadata 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.

Link to this function path(snapshot_metadata) View Source
path(t) :: Croma.String.t

Type-aware getter for path.

Type-aware setter for path.

Type-aware getter for size.

Type-aware setter for size.

Type-aware getter for term.

Type-aware setter for term.

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

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.

Checks that the given dict is valid or not by using each field’s validate/1 function. Returns {:ok, valid_struct} or {:error, reason}.

Link to this function validate!(dict) View Source
validate!(Dict.t) :: t

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