RaftedValue.Persistence.SnapshotMetadata (rafted_value v0.12.0)

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

Types

t()

@type t() :: %RaftedValue.Persistence.SnapshotMetadata{
  last_committed_index: RaftedValue.LogIndex.t(),
  path: Croma.String.t(),
  size: Croma.PosInteger.t(),
  term: RaftedValue.TermNumber.t()
}

Functions

last_committed_index(snapshot_metadata)

@spec last_committed_index(t()) :: RaftedValue.LogIndex.t()

Type-aware getter for last_committed_index.

last_committed_index(s, field)

@spec last_committed_index(t(), RaftedValue.LogIndex.t()) :: t()

Type-aware setter for last_committed_index.

new(dict)

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

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

path(snapshot_metadata)

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

Type-aware getter for path.

path(s, field)

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

Type-aware setter for path.

size(snapshot_metadata)

@spec size(t()) :: Croma.PosInteger.t()

Type-aware getter for size.

size(s, field)

@spec size(t(), Croma.PosInteger.t()) :: t()

Type-aware setter for size.

term(snapshot_metadata)

@spec term(t()) :: RaftedValue.TermNumber.t()

Type-aware getter for term.

term(s, field)

@spec term(t(), RaftedValue.TermNumber.t()) :: t()

Type-aware setter for term.

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.