ExEEx.Adapter behaviour (exeex v0.2.0)

Copy Markdown

Specifies the minimal API required from storage adapters.

Summary

Callbacks

expand_path(filepath)
expand_path(filepath, rootdir)
read(filepath)
read(filepath, rootdir)

Callbacks

expand_path(filepath)

@callback expand_path(filepath :: String.t()) :: String.t()

expand_path(filepath, rootdir)

@callback expand_path(filepath :: String.t(), rootdir :: String.t()) :: String.t()

read(filepath)

@callback read(filepath :: String.t()) :: {:ok, String.t()} | {:error, term()}

read(filepath, rootdir)

@callback read(filepath :: String.t(), rootdir :: String.t()) ::
  {:ok, String.t()} | {:error, term()}