MingaAgent.ProjectView.Backend behaviour (Minga v0.1.0)

@type capabilities() :: %{
  isolation: :none | :overlay,
  mutates_project_root: boolean(),
  supports_promote: boolean(),
  supports_discard: boolean(),
  supports_command_env: boolean()
}

Backend capability flags.

directory_entry()

@type directory_entry() :: %{name: String.t(), type: :file | :directory}

Directory listing entry.

ref()

@type ref() :: term()

Backend-owned reference, usually a pid or small state map.

Callbacks

capabilities(t)

@callback capabilities(MingaAgent.ProjectView.t()) :: capabilities()

close(t)

@callback close(MingaAgent.ProjectView.t()) :: :ok | {:error, term()}

command_env(t)

@callback command_env(MingaAgent.ProjectView.t()) ::
  [{String.t(), String.t()}] | {:error, term()}

delete_file(t, t)

@callback delete_file(MingaAgent.ProjectView.t(), String.t()) :: :ok | {:error, term()}

diff(t)

@callback diff(MingaAgent.ProjectView.t()) :: {:ok, [map()]} | {:error, term()}

discard(t)

@callback discard(MingaAgent.ProjectView.t()) :: :ok | {:error, term()}

discard_file(t, t)

@callback discard_file(MingaAgent.ProjectView.t(), String.t()) :: :ok | {:error, term()}

edit_file(t, t, t, t)

@callback edit_file(MingaAgent.ProjectView.t(), String.t(), String.t(), String.t()) ::
  :ok | {:error, term()}

list_directory(t, t)

@callback list_directory(MingaAgent.ProjectView.t(), String.t()) ::
  {:ok, [directory_entry()]} | {:error, term()}

promote(t, term)

@callback promote(MingaAgent.ProjectView.t(), term()) ::
  :ok | {:conflict, map()} | {:error, term()}

read_file(t, t)

@callback read_file(MingaAgent.ProjectView.t(), String.t()) ::
  {:ok, binary()} | {:error, term()}

working_dir(t)

@callback working_dir(MingaAgent.ProjectView.t()) :: String.t() | {:error, term()}

write_file(t, t, binary)

@callback write_file(MingaAgent.ProjectView.t(), String.t(), binary()) ::
  :ok | {:error, term()}