Opus.Pipeline.Stage.Skip (Opus v0.7.0) View Source

The skip stage is meant to halt the pipeline with no error if the given condition is true. This stage must be called with an if option, in order to decide if the pipeline is going to be halted or not.

When the given conditional is true, the pipeline will return {:ok, :skipped} and all the following steps will be skipped.

defmodule CreateUserPipeline do
  use Opus.Pipeline

  skip :prevent_duplicates, if: :user_exists?
  step :persist_user
end

In this example, if the user_exists? implementation returns true, then the next step persist_user is not going to be called. If false or any other value, then Opus will keep following to the next stages.

Link to this section Summary

Link to this section Functions

Callback implementation for Opus.Pipeline.Stage.run/2.