WardrikWorkspace.Spec (wardrik_workspace v0.1.0-rc.1)

What an agent's file tools reach.

Summary

t()

mounts(spec)

Returns every mount the spec reaches, its own first.

new(opts)

Builds a spec from WardrikWorkspace's options: :store, :tree and :shared.

Returns the mount path is in and the path within its tree, or {:error, reason}.

Returns path as the agent sees it, prefixed with shared/<name>/ for a shared mount.

@type t() :: %WardrikWorkspace.Spec{
  own: WardrikWorkspace.Mount.t(),
  shared: [WardrikWorkspace.Mount.t()],
  store: WardrikStore.t()
}

@spec mounts(t()) :: [WardrikWorkspace.Mount.t()]

Returns every mount the spec reaches, its own first.

@spec new(keyword()) :: t()

Builds a spec from WardrikWorkspace's options: :store, :tree and :shared.

@spec resolve(t(), term()) ::
  {:ok, WardrikWorkspace.Mount.t(), String.t()} | {:error, String.t()}

Returns the mount path is in and the path within its tree, or {:error, reason}.

@spec shown(WardrikWorkspace.Mount.t(), String.t()) :: String.t()

Returns path as the agent sees it, prefixed with shared/<name>/ for a shared mount.