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

Command execution boundary for HostKit apply/deploy operations.

Summary

args()

command()

opts()

result()

mkdir_p(t, opts)

@type args() :: [String.t()]

@type command() :: String.t()

@type opts() :: keyword()

@type result() :: {String.t(), non_neg_integer()}

@callback cmd(command(), args(), opts()) :: result()

@callback mkdir_p(Path.t(), opts()) :: :ok | {:error, term()}

@callback write_file(Path.t(), iodata(), opts()) :: :ok | {:error, term()}

@spec cmd(module() | {module(), keyword()}, command(), args(), opts()) :: result()

@spec mkdir_p(module() | {module(), keyword()}, Path.t(), opts()) ::
  :ok | {:error, term()}

@spec read_file(Path.t(), opts()) :: {:ok, binary()} | {:error, term()}

@spec write_file(module() | {module(), keyword()}, Path.t(), iodata(), opts()) ::
  :ok | {:error, term()}