FerricStore.ResourceLimits behaviour (ferricstore v0.5.7)

Stable resource-limit contract for FerricStore control planes and write paths.

The public management commands use set_limit/3, get_limit/2, and usage/2. Internal enforcement points can use check/4, reserve/4, and release/2 without coupling storage code to any specific limit backend.

Summary

amount()

limit_spec()

reservation()

resource()

result()

scope()

@type amount() :: non_neg_integer()

@type limit_spec() :: map()

@type reservation() :: term()

@type resource() :: atom() | binary()

@type result() :: :ok | {:ok, term()} | {:error, term()}

@type scope() :: binary() | map()

@callback check(scope(), resource(), amount(), keyword()) :: :ok | {:error, term()}

@callback get_limit(
  scope(),
  keyword()
) :: result()

@callback release(
  reservation(),
  keyword()
) :: :ok | {:error, term()}

@callback reserve(scope(), resource(), amount(), keyword()) ::
  {:ok, reservation()} | {:error, term()}

@callback set_limit(scope(), limit_spec(), keyword()) :: result()

@callback usage(
  scope(),
  keyword()
) :: result()

@spec check(scope(), resource(), amount(), keyword()) :: :ok | {:error, term()}

@spec get_limit(
  scope(),
  keyword()
) :: result()

@spec release(
  reservation(),
  keyword()
) :: :ok | {:error, term()}

@spec reserve(scope(), resource(), amount(), keyword()) ::
  {:ok, reservation()} | {:error, term()}

@spec set_limit(scope(), limit_spec(), keyword()) :: result()

@spec usage(
  scope(),
  keyword()
) :: result()