ASM.Extensions.Workspace.Backend behaviour (ASM v0.17.3)

Copy Markdown View Source

Behavior contract for workspace snapshot backends.

Summary

Callbacks

diff(t, t, keyword)
rollback(t, keyword)
snapshot(t, keyword)

Callbacks

diff(t, t, keyword)

@callback diff(
  ASM.Extensions.Workspace.Snapshot.t(),
  ASM.Extensions.Workspace.Snapshot.t(),
  keyword()
) ::
  {:ok, ASM.Extensions.Workspace.Diff.t()} | {:error, ASM.Error.t()}

rollback(t, keyword)

@callback rollback(ASM.Extensions.Workspace.Snapshot.t(), keyword()) ::
  :ok | {:error, ASM.Error.t()}

snapshot(t, keyword)

@callback snapshot(String.t(), keyword()) ::
  {:ok, ASM.Extensions.Workspace.Snapshot.t()} | {:error, ASM.Error.t()}