HostKit.Instance.Backend behaviour (host_kit v0.1.0-beta.2)

Backend behaviour for lifecycle-managed HostKit instances.

Summary

read(t, keyword)

module(backend)

@callback apply(
  HostKit.Instance.t(),
  keyword()
) :: :ok | {:error, term()}

@callback delete(
  HostKit.Instance.t(),
  keyword()
) :: :ok | {:error, term()}

@callback read(
  HostKit.Instance.t(),
  keyword()
) :: {:ok, HostKit.Instance.t() | nil} | {:error, term()}

@spec apply(
  HostKit.Instance.t(),
  keyword()
) :: :ok | {:error, term()}

@spec delete(
  HostKit.Instance.t(),
  keyword()
) :: :ok | {:error, term()}

@spec module(atom()) :: module()

@spec read(
  HostKit.Instance.t(),
  keyword()
) :: {:ok, HostKit.Instance.t() | nil} | {:error, term()}