View Source RaftedValue.RPC.RequestVoteRequest (rafted_value v0.11.2)

Link to this section Summary

Functions

Type-aware getter for candidate_pid.

Type-aware setter for candidate_pid.

Type-aware getter for last_log.

Type-aware setter for last_log.

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

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

Type-aware getter for replacing_leader.

Type-aware setter for replacing_leader.

Type-aware getter for term.

Type-aware setter for term.

Updates an existing instance of RaftedValue.RPC.RequestVoteRequest 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

@type t() :: %RaftedValue.RPC.RequestVoteRequest{
  candidate_pid: Croma.Atom.t(),
  last_log: RaftedValue.LogInfo.t(),
  replacing_leader: Croma.Boolean.t(),
  term: RaftedValue.TermNumber.t()
}

Link to this section Functions

Link to this function

candidate_pid(request_vote_request)

View Source
@spec candidate_pid(t()) :: Croma.Atom.t()

Type-aware getter for candidate_pid.

@spec candidate_pid(t(), Croma.Atom.t()) :: t()

Type-aware setter for candidate_pid.

Link to this function

last_log(request_vote_request)

View Source
@spec last_log(t()) :: RaftedValue.LogInfo.t()

Type-aware getter for last_log.

@spec last_log(t(), RaftedValue.LogInfo.t()) :: t()

Type-aware setter for last_log.

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

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

See also moduledoc of Croma.Struct.

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

Link to this function

replacing_leader(request_vote_request)

View Source
@spec replacing_leader(t()) :: Croma.Boolean.t()

Type-aware getter for replacing_leader.

Link to this function

replacing_leader(s, field)

View Source
@spec replacing_leader(t(), Croma.Boolean.t()) :: t()

Type-aware setter for replacing_leader.

Link to this function

term(request_vote_request)

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

Type-aware getter for term.

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

Type-aware setter for term.

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

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

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

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

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