rafted_value

v0.7.2

rafted_value v0.7.2 RaftedValue.RPC.RequestVoteResponse View Source

Link to this section 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

Link to this section Types

Link to this type t() View Source 
t() :: %RaftedValue.RPC.RequestVoteResponse{from: Croma.Pid.t(), term: RaftedValue.TermNumber.t(), vote_granted: Croma.Boolean.t()}

Link to this section Functions

Link to this function from(request_vote_response) View Source 
from(t()) :: Croma.Pid.t()

Type-aware getter for from.

Link to this function from(s, field) View Source 
from(t(), Croma.Pid.t()) :: t()

Type-aware setter for from.

Link to this function new(dict) View Source 
new(term()) :: Croma.Result.t(t())

Creates a new instance of RaftedValue.RPC.RequestVoteResponse 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 valid?/1 function.

Link to this function new!(dict) View Source 
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 term(request_vote_response) View Source 
term(t()) :: RaftedValue.TermNumber.t()

Type-aware getter for term.

Link to this function term(s, field) View Source 
term(t(), RaftedValue.TermNumber.t()) :: t()

Type-aware setter for term.

Link to this function update(s, dict) View Source 
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}.

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.

Link to this function valid?(value) View Source 
valid?(term()) :: boolean()

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

Link to this function vote_granted(request_vote_response) View Source 
vote_granted(t()) :: Croma.Boolean.t()

Type-aware getter for vote_granted.

Link to this function vote_granted(s, field) View Source 
vote_granted(t(), Croma.Boolean.t()) :: t()

Type-aware setter for vote_granted.