exfile v0.3.6 Exfile.Processor behaviour View Source

A behaviour defining the API a Processor should adhere to.

Link to this section Summary

Types

file()

Callbacks

call(file, list, list)

Processes the file, returns {:ok, result} on success or {:error, reason} on failure

Link to this section Types

Link to this type file() View Source

file() :: %Exfile.LocalFile{io: term, meta: term, path: term}

Link to this section Callbacks

Link to this callback call(file, list, list) View Source

call(file, [String.t, ...], [{atom, any}]) ::
  {:ok, file} |
  {:error, atom}

Processes the file, returns {:ok, result} on success or {:error, reason} on failure.