rafted_value

v0.11.1

rafted_value v0.11.1 RaftedValue.Config View Source

Link to this section Summary

Types

t()

Functions

communication_module(config)

Type-aware getter for communication_module.

communication_module(s, field)

Type-aware setter for communication_module.

data_module(config)

Type-aware getter for data_module.

data_module(s, field)

Type-aware setter for data_module.

election_timeout(config)

Type-aware getter for election_timeout.

election_timeout(s, field)

Type-aware setter for election_timeout.

election_timeout_clock_drift_margin(config)

Type-aware getter for election_timeout_clock_drift_margin.

election_timeout_clock_drift_margin(s, field)

Type-aware setter for election_timeout_clock_drift_margin.

heartbeat_timeout(config)

Type-aware getter for heartbeat_timeout.

heartbeat_timeout(s, field)

Type-aware setter for heartbeat_timeout.

leader_hook_module(config)

Type-aware getter for leader_hook_module.

leader_hook_module(s, field)

Type-aware setter for leader_hook_module.

max_retained_command_results(config)

Type-aware getter for max_retained_command_results.

max_retained_command_results(s, field)

Type-aware setter for max_retained_command_results.

new(dict)

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

new!(dict)

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

update(s, dict)

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

Link to this section Types

Link to this type

t() View Source 
t() :: %RaftedValue.Config{
  communication_module: Croma.Atom.t(),
  data_module: Croma.Atom.t(),
  election_timeout: Croma.PosInteger.t(),
  election_timeout_clock_drift_margin: Croma.PosInteger.t(),
  heartbeat_timeout: Croma.PosInteger.t(),
  leader_hook_module: Croma.Atom.t(),
  max_retained_command_results: Croma.PosInteger.t()
}

Link to this section Functions

Link to this function

communication_module(config) View Source 
communication_module(t()) :: Croma.Atom.t()

Type-aware getter for communication_module.

Link to this function

communication_module(s, field) View Source 
communication_module(t(), Croma.Atom.t()) :: t()

Type-aware setter for communication_module.

Link to this function

data_module(config) View Source 
data_module(t()) :: Croma.Atom.t()

Type-aware getter for data_module.

Link to this function

data_module(s, field) View Source 
data_module(t(), Croma.Atom.t()) :: t()

Type-aware setter for data_module.

Link to this function

election_timeout(config) View Source 
election_timeout(t()) :: Croma.PosInteger.t()

Type-aware getter for election_timeout.

Link to this function

election_timeout(s, field) View Source 
election_timeout(t(), Croma.PosInteger.t()) :: t()

Type-aware setter for election_timeout.

Link to this function

election_timeout_clock_drift_margin(config) View Source 
election_timeout_clock_drift_margin(t()) :: Croma.PosInteger.t()

Type-aware getter for election_timeout_clock_drift_margin.

Link to this function

election_timeout_clock_drift_margin(s, field) View Source 
election_timeout_clock_drift_margin(t(), Croma.PosInteger.t()) :: t()

Type-aware setter for election_timeout_clock_drift_margin.

Link to this function

heartbeat_timeout(config) View Source 
heartbeat_timeout(t()) :: Croma.PosInteger.t()

Type-aware getter for heartbeat_timeout.

Link to this function

heartbeat_timeout(s, field) View Source 
heartbeat_timeout(t(), Croma.PosInteger.t()) :: t()

Type-aware setter for heartbeat_timeout.

Link to this function

leader_hook_module(config) View Source 
leader_hook_module(t()) :: Croma.Atom.t()

Type-aware getter for leader_hook_module.

Link to this function

leader_hook_module(s, field) View Source 
leader_hook_module(t(), Croma.Atom.t()) :: t()

Type-aware setter for leader_hook_module.

Link to this function

max_retained_command_results(config) View Source 
max_retained_command_results(t()) :: Croma.PosInteger.t()

Type-aware getter for max_retained_command_results.

Link to this function

max_retained_command_results(s, field) View Source 
max_retained_command_results(t(), Croma.PosInteger.t()) :: t()

Type-aware setter for max_retained_command_results.

Link to this function

new(dict) View Source 
new(term()) :: Croma.Result.t(t())

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

update(s, dict) View Source 
update(t(), Dict.t()) :: Croma.Result.t(t())

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