Aludel.Storage (aludel v0.2.0)

Domain-facing facade for document storage backends.

Test case documents are persisted through the configured storage adapter.

Summary

config()

error_reason()

adapter()

config()

Persists document contents through the configured adapter and returns the adapter-specific storage key to save with the document row.

@type config() :: keyword()

@type error_reason() :: term()

@spec adapter() :: module()

@spec backend_name(module()) :: String.t()

@spec config() :: config()

@spec delete(
  String.t(),
  keyword()
) :: :ok | {:error, error_reason()}

@spec get(
  String.t(),
  keyword()
) :: {:ok, binary()} | {:error, error_reason()}

@spec put(String.t(), binary(), String.t()) ::
  {:ok, String.t()} | {:error, error_reason()}

Persists document contents through the configured adapter and returns the adapter-specific storage key to save with the document row.

@spec read(Aludel.Evals.TestCaseDocument.t()) ::
  {:ok, binary()} | {:error, error_reason()}

@spec resolve_backend(String.t() | nil) ::
  {:ok, module()} | {:error, :unknown_storage_backend}

@spec storage_key(Ecto.UUID.t(), String.t()) :: String.t()