ExRingRing.Domain.Services.HashRing behaviour (ex_ring_ring v0.1.0)

Domain service behavior for hash ring operations.

This defines the contract for hash ring implementations.

Summary

fold_fun()

item()

node_map()

get_nodes(term)

hash(item, term)

make(list, t)

@type fold_fun() :: (ExRingRing.Domain.Entities.Node.t(), term() ->
                 {boolean(), term()})

@type item() :: term()

@type node_map() :: %{required(term()) => ExRingRing.Domain.Entities.Node.t()}

@callback add_nodes([ExRingRing.Domain.Entities.Node.t()], term()) :: term()

@callback fold(fold_fun(), item(), term(), term()) :: term()

@callback get_nodes(term()) :: node_map()

@callback get_non_phantom_node_count(term()) :: non_neg_integer()

@callback hash(item(), term()) :: non_neg_integer()

@callback make(
  [ExRingRing.Domain.Entities.Node.t()],
  ExRingRing.Domain.ValueObjects.HashConfig.t()
) ::
  term()

@callback remove_nodes([atom() | binary() | integer()], term()) :: term()