RaftedValue.RPC.RequestVoteResponse (rafted_value v0.12.0)

Summary

Types

t()

Functions

from(request_vote_response)

Type-aware getter for from.

from(s, field)

Type-aware setter for from.

new(dict)

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

new!(dict)

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

term(request_vote_response)

Type-aware getter for term.

term(s, field)

Type-aware setter for term.

update(s, dict)

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

vote_granted(request_vote_response)

Type-aware getter for vote_granted.

vote_granted(s, field)

Type-aware setter for vote_granted.

Types

t()

@type t() :: %RaftedValue.RPC.RequestVoteResponse{
  from: Croma.Pid.t(),
  term: RaftedValue.TermNumber.t(),
  vote_granted: Croma.Boolean.t()
}

Functions

from(request_vote_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.

new(dict)

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

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

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.

term(request_vote_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())

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

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

vote_granted(request_vote_response)

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

Type-aware getter for vote_granted.

vote_granted(s, field)

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

Type-aware setter for vote_granted.