rafted_value v0.1.1 RaftedValue.Server.State

Summary

Functions

Type-aware getter for command_results

Type-aware setter for command_results

Type-aware getter for config

Type-aware setter for config

Type-aware getter for current_term

Type-aware setter for current_term

Type-aware getter for data

Type-aware setter for data

Type-aware getter for election

Type-aware setter for election

Type-aware getter for leadership

Type-aware setter for leadership

Type-aware getter for logs

Type-aware setter for logs

Type-aware getter for members

Type-aware setter for members

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

Updates an existing instance of Elixir.RaftedValue.Server.State 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.Server.State{command_results: RaftedValue.CommandResults.t, config: RaftedValue.Config.t, current_term: RaftedValue.TermNumber.t, data: Croma.Any.t, election: RaftedValue.Election.t, leadership: Croma.TypeGen.Nilable.RaftedValue.Leadership.t, logs: RaftedValue.Logs.t, members: RaftedValue.Members.t}

Functions

command_results(state)

Specs

command_results(t) :: RaftedValue.CommandResults.t

Type-aware getter for command_results.

command_results(s, field)

Specs

command_results(t, RaftedValue.CommandResults.t) :: t

Type-aware setter for command_results.

config(state)

Specs

config(t) :: RaftedValue.Config.t

Type-aware getter for config.

config(s, field)

Specs

config(t, RaftedValue.Config.t) :: t

Type-aware setter for config.

current_term(state)

Specs

current_term(t) :: RaftedValue.TermNumber.t

Type-aware getter for current_term.

current_term(s, field)

Specs

current_term(t, RaftedValue.TermNumber.t) :: t

Type-aware setter for current_term.

data(state)

Specs

data(t) :: Croma.Any.t

Type-aware getter for data.

data(s, field)

Specs

data(t, Croma.Any.t) :: t

Type-aware setter for data.

election(state)

Specs

election(t) :: RaftedValue.Election.t

Type-aware getter for election.

election(s, field)

Specs

election(t, RaftedValue.Election.t) :: t

Type-aware setter for election.

leadership(state)

Specs

leadership(t) :: Croma.TypeGen.Nilable.RaftedValue.Leadership.t

Type-aware getter for leadership.

leadership(s, field)

Specs

leadership(t, Croma.TypeGen.Nilable.RaftedValue.Leadership.t) :: t

Type-aware setter for leadership.

logs(state)

Specs

Type-aware getter for logs.

logs(s, field)

Specs

logs(t, RaftedValue.Logs.t) :: t

Type-aware setter for logs.

members(state)

Specs

members(t) :: RaftedValue.Members.t

Type-aware getter for members.

members(s, field)

Specs

members(t, RaftedValue.Members.t) :: t

Type-aware setter for members.

new(dict)

Specs

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

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

update(s, dict)

Specs

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

Updates an existing instance of Elixir.RaftedValue.Server.State 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.