HostKit.Package behaviour (host_kit v0.1.0-beta.1)

Runtime boundary for reading and installing OS packages.

Summary

read(t, map)

@callback install(
  HostKit.Resources.Package.t(),
  keyword()
) :: :ok | {:error, term()}

(optional)

@callback install_many(
  [HostKit.Resources.Package.t()],
  keyword()
) :: :ok | {:error, term()}

@callback read(HostKit.Resources.Package.t(), map()) ::
  {:ok, HostKit.Resources.Package.t() | nil} | {:error, term()}

@spec install(
  HostKit.Resources.Package.t(),
  keyword()
) :: :ok | {:error, term()}

@spec install_many(
  [HostKit.Resources.Package.t()],
  keyword()
) :: :ok | {:error, term()}

@spec read(HostKit.Resources.Package.t(), map()) ::
  {:ok, HostKit.Resources.Package.t() | nil} | {:error, term()}