rafted_value v0.1.1 RaftedValue.RPC.RequestVoteRequest

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 Elixir.RaftedValue.RPC.RequestVoteRequest by using the given dict and the default value of each field. Returns {:ok, valid_struct} or {:error, reason}. The values in the dict are validated by each field’s validate/1 function

A variant of new/1 which returns t or raise if validation fails. In other words, new/1 followed by Croma.Result.get!/1

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 Elixir.RaftedValue.RPC.RequestVoteRequest with the given dict. The values in the dict are validated by each field’s validate/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 that the given dict is valid or not by using each field’s validate/1 function. Returns {:ok, valid_struct} or {:error, reason}

A variant of validate/1 which returns t or raise if validation fails. In other words, validate/1 followed by Croma.Result.get!/1

Types

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

Functions

candidate_pid(request_vote_request)

Specs

candidate_pid(t) :: Croma.Atom.t

Type-aware getter for candidate_pid.

candidate_pid(s, field)

Specs

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

Type-aware setter for candidate_pid.

last_log(request_vote_request)

Specs

last_log(t) :: RaftedValue.LogInfo.t

Type-aware getter for last_log.

last_log(s, field)

Specs

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

Type-aware setter for last_log.

new(dict)

Specs

new(Dict.t) :: Croma.Result.t(t)

Creates a new instance of Elixir.RaftedValue.RPC.RequestVoteRequest by using the given dict and the default value of each field. Returns {:ok, valid_struct} or {:error, reason}. The values in the dict are validated by each field’s validate/1 function.

new!(dict)

Specs

new!(Dict.t) :: 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.

replacing_leader(request_vote_request)

Specs

replacing_leader(t) :: Croma.Boolean.t

Type-aware getter for replacing_leader.

replacing_leader(s, field)

Specs

replacing_leader(t, Croma.Boolean.t) :: t

Type-aware setter for replacing_leader.

term(request_vote_request)

Specs

Type-aware getter for term.

term(s, field)

Specs

Type-aware setter for term.

update(s, dict)

Specs

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

Updates an existing instance of Elixir.RaftedValue.RPC.RequestVoteRequest with the given dict. The values in the dict are validated by each field’s validate/1 function. Returns {:ok, valid_struct} or {:error, reason}.

update!(s, dict)

Specs

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.

validate(dict)

Specs

validate(Dict.t) :: Croma.Result.t(t)

Checks that the given dict is valid or not by using each field’s validate/1 function. Returns {:ok, valid_struct} or {:error, reason}.

validate!(dict)

Specs

validate!(Dict.t) :: t

A variant of validate/1 which returns t or raise if validation fails. In other words, validate/1 followed by Croma.Result.get!/1.