RaftedValue.RPC.AppendEntriesResponse (rafted_value v0.12.0)

Updates an existing instance of RaftedValue.RPC.AppendEntriesResponse 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.RPC.AppendEntriesResponse{
  from: Croma.Pid.t(),
  i_replicated: Croma.TypeGen.Nilable.RaftedValue.LogIndex.t(),
  leader_timestamp: RaftedValue.Monotonic.t(),
  success: Croma.Boolean.t(),
  term: RaftedValue.TermNumber.t()
}

Functions

from(append_entries_response)

@spec from(t()) :: Croma.Pid.t()

Type-aware getter for from.

from(s, field)

@spec from(t(), Croma.Pid.t()) :: t()

Type-aware setter for from.

i_replicated(append_entries_response)

@spec i_replicated(t()) :: Croma.TypeGen.Nilable.RaftedValue.LogIndex.t()

Type-aware getter for i_replicated.

i_replicated(s, field)

@spec i_replicated(t(), Croma.TypeGen.Nilable.RaftedValue.LogIndex.t()) :: t()

Type-aware setter for i_replicated.

leader_timestamp(append_entries_response)

@spec leader_timestamp(t()) :: RaftedValue.Monotonic.t()

Type-aware getter for leader_timestamp.

leader_timestamp(s, field)

@spec leader_timestamp(t(), RaftedValue.Monotonic.t()) :: t()

Type-aware setter for leader_timestamp.

new(dict)

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

Creates a new instance of RaftedValue.RPC.AppendEntriesResponse 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.

success(append_entries_response)

@spec success(t()) :: Croma.Boolean.t()

Type-aware getter for success.

success(s, field)

@spec success(t(), Croma.Boolean.t()) :: t()

Type-aware setter for success.

term(append_entries_response)

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