raft_kv v0.2.0 RaftKV.KeyspaceInfo View Source

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

t()

t() :: %RaftKV.KeyspaceInfo{
  policy: RaftKV.SplitMergePolicy.t(),
  shards: Croma.Tuple.t()
}

Link to this section Functions

add_shard(info, new_range_start)

add_shard(RaftKV.KeyspaceInfo.t(), RaftKV.Hash.t()) :: t()

check_if_mergeable(info, range_start1, range_start2)

check_if_mergeable(RaftKV.KeyspaceInfo.t(), RaftKV.Hash.t(), RaftKV.Hash.t()) ::
  {:ok, t()} | :error

check_if_splittable(info, range_start)

check_if_splittable(RaftKV.KeyspaceInfo.t(), RaftKV.Hash.t()) ::
  {:ok, t(), RaftKV.Hash.t()} | :error

make(policy)

make(RaftKV.SplitMergePolicy.t()) :: t()

new(dict)

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.

new!(dict)

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.

policy(keyspace_info)

policy(t()) :: RaftKV.SplitMergePolicy.t()

Type-aware getter for policy.

policy(s, field)

policy(t(), RaftKV.SplitMergePolicy.t()) :: t()

Type-aware setter for policy.

shard_range_start_positions(a0)

shard_range_start_positions(RaftKV.KeyspaceInfo.t()) :: [RaftKV.Hash.t()]

shards(keyspace_info)

shards(t()) :: Croma.Tuple.t()

Type-aware getter for shards.

shards(s, field)

shards(t(), Croma.Tuple.t()) :: t()

Type-aware setter for shards.

store(info, map, threshold_time)

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()}]}

touch_and_delete(info, range_start1, range_start2, time)

touch_and_delete(
  RaftKV.KeyspaceInfo.t(),
  RaftKV.Hash.t(),
  RaftKV.Hash.t(),
  pos_integer()
) :: t()

touch_both(info, range_start1, range_start2, time)

touch_both(
  RaftKV.KeyspaceInfo.t(),
  RaftKV.Hash.t(),
  RaftKV.Hash.t(),
  pos_integer()
) :: t()

update(s, dict)

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

update!(s, dict)

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.

valid?(value)

valid?(term()) :: boolean()

Checks if the given value belongs to t/0 or not.