raft_kv

v0.2.5

raft_kv v0.2.5 RaftKV.KeyspaceInfo View Source

Link to this section Summary

Types

t()

Functions

add_shard(info, new_range_start)
check_if_mergeable(info, range_start1, range_start2)
check_if_splittable(info, range_start)
make(policy)
new(dict)

Creates a new instance of RaftKV.KeyspaceInfo by using the given dict.

new!(dict)

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

policy(keyspace_info)

Type-aware getter for policy.

policy(s, field)

Type-aware setter for policy.

shard_range_start_positions(arg0)
shards(keyspace_info)

Type-aware getter for shards.

shards(s, field)

Type-aware setter for shards.

store(info, map, threshold_time)
touch_and_delete(info, range_start1, range_start2, time)
touch_both(info, range_start1, range_start2, time)
update(s, dict)

Updates an existing instance of RaftKV.KeyspaceInfo 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() :: %RaftKV.KeyspaceInfo{
  policy: RaftKV.SplitMergePolicy.t(),
  shards: Croma.Tuple.t()
}

Link to this section Functions

Link to this function

add_shard(info, new_range_start) View Source 
add_shard(RaftKV.KeyspaceInfo.t(), RaftKV.Hash.t()) :: t()

Link to this function

check_if_mergeable(info, range_start1, range_start2) View Source 
check_if_mergeable(RaftKV.KeyspaceInfo.t(), RaftKV.Hash.t(), RaftKV.Hash.t()) ::
  {:ok, t()} | :error

Link to this function

check_if_splittable(info, range_start) View Source 
check_if_splittable(RaftKV.KeyspaceInfo.t(), RaftKV.Hash.t()) ::
  {:ok, t(), RaftKV.Hash.t()} | :error

Link to this function

make(policy) View Source 
make(RaftKV.SplitMergePolicy.t()) :: t()

Link to this function

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

Creates a new instance of RaftKV.KeyspaceInfo 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

policy(keyspace_info) View Source 
policy(t()) :: RaftKV.SplitMergePolicy.t()

Type-aware getter for policy.

Link to this function

policy(s, field) View Source 
policy(t(), RaftKV.SplitMergePolicy.t()) :: t()

Type-aware setter for policy.

Link to this function

shard_range_start_positions(arg0) View Source 
shard_range_start_positions(RaftKV.KeyspaceInfo.t()) :: [RaftKV.Hash.t()]

Link to this function

shards(keyspace_info) View Source 
shards(t()) :: Croma.Tuple.t()

Type-aware getter for shards.

Link to this function

shards(s, field) View Source 
shards(t(), Croma.Tuple.t()) :: t()

Type-aware setter for shards.

Link to this function

store(info, map, threshold_time) View Source 
store(
  RaftKV.KeyspaceInfo.t(),
  %{
    optional(RaftKV.Hash.t()) =>
      {non_neg_integer(), non_neg_integer(), non_neg_integer(),
       non_neg_integer()}
  },
  pos_integer()
) ::
  {t(), [{float(), RaftKV.Hash.t()}],
   [{float(), RaftKV.Hash.t(), RaftKV.Hash.t()}]}

Link to this function

touch_and_delete(info, range_start1, range_start2, time) View Source 
touch_and_delete(
  RaftKV.KeyspaceInfo.t(),
  RaftKV.Hash.t(),
  RaftKV.Hash.t(),
  pos_integer()
) :: t()

Link to this function

touch_both(info, range_start1, range_start2, time) View Source 
touch_both(
  RaftKV.KeyspaceInfo.t(),
  RaftKV.Hash.t(),
  RaftKV.Hash.t(),
  pos_integer()
) :: t()

Link to this function

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

Updates an existing instance of RaftKV.KeyspaceInfo 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.