rafted_value v0.1.1 RaftedValue.RPC.AppendEntriesRequest

Summary

Functions

Type-aware getter for entries

Type-aware setter for entries

Type-aware getter for i_leader_commit

Type-aware setter for i_leader_commit

Type-aware getter for leader_pid

Type-aware setter for leader_pid

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

Type-aware setter for prev_log

Type-aware getter for term

Type-aware setter for term

Updates an existing instance of Elixir.RaftedValue.RPC.AppendEntriesRequest 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.AppendEntriesRequest{entries: Croma.TypeGen.ListOf.RaftedValue.LogEntry.t, i_leader_commit: RaftedValue.LogIndex.t, leader_pid: Croma.Pid.t, prev_log: RaftedValue.LogInfo.t, term: RaftedValue.TermNumber.t}

Functions

entries(append_entries_request)

Specs

entries(t) :: Croma.TypeGen.ListOf.RaftedValue.LogEntry.t

Type-aware getter for entries.

entries(s, field)

Specs

entries(t, Croma.TypeGen.ListOf.RaftedValue.LogEntry.t) :: t

Type-aware setter for entries.

i_leader_commit(append_entries_request)

Specs

i_leader_commit(t) :: RaftedValue.LogIndex.t

Type-aware getter for i_leader_commit.

i_leader_commit(s, field)

Specs

i_leader_commit(t, RaftedValue.LogIndex.t) :: t

Type-aware setter for i_leader_commit.

leader_pid(append_entries_request)

Specs

leader_pid(t) :: Croma.Pid.t

Type-aware getter for leader_pid.

leader_pid(s, field)

Specs

leader_pid(t, Croma.Pid.t) :: t

Type-aware setter for leader_pid.

new(dict)

Specs

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

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

prev_log(append_entries_request)

Specs

prev_log(t) :: RaftedValue.LogInfo.t

Type-aware getter for prev_log.

prev_log(s, field)

Specs

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

Type-aware setter for prev_log.

term(append_entries_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.AppendEntriesRequest 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.