record_list v0.1.3

View Source RecordList.StepBehaviour behaviour (record_list v0.1.3)

A behaviour to be implemented by the implementation modules of steps defined in the options to the RecordList.__using__/1 macro.

Link to this section Summary

Callbacks

execute(t, step, step_opts)

The RecordList pipeline will call execute/3 on the implementation for each step defined. The second step argument will be the name of the step, e.g. :sort, or :paginate.

Link to this section Callbacks

Link to this callback

execute(t, step, step_opts)

View Source 
@callback execute(RecordList.t(), step :: atom(), step_opts :: Keyword.t()) ::
  RecordList.t()

The RecordList pipeline will call execute/3 on the implementation for each step defined. The second step argument will be the name of the step, e.g. :sort, or :paginate.

  def execute(%RecordList{}, :sort, opts) do
    ...
  end

This allows the same module to define execute/3 implementations for various steps.