The pipe operator
|> passes the result of an expression as the first parameter of another expression.
Programming can get messy. So messy in fact that function calls can get so embedded that they become difficult to follow. Take the following nested functions into consideration:
Here, we are passing the value
bar/1, and finally the result of
foo/1. Elixir takes a pragmatic approach to this syntactical chaos by giving us the pipe operator. The pipe operator which looks like
|> takes the result of one expression, and passes it on. Let’s take another look at the code snippet above rewritten using the pipe operator.
other_function() |> new_function() |> baz() |> bar() |> foo()
The pipe takes the result on the left, and passes it to the right hand side.
For this set of examples, we will use Elixir’s String module.
iex> "Elixir rocks" |> String.split ["Elixir", "rocks"]
iex> "Elixir rocks" |> String.upcase |> String.split ["ELIXIR", "ROCKS"]
iex> "elixir" |> String.ends_with?("ixir") true
If the arity of a function is more than 1, then make sure to use parentheses. This doesn’t matter much to the Elixir, but it matters to other programmers who may misinterpret your code. It does matter with the pipe operator though. For example, if we take our third example, and remove the parentheses from
String.ends_with?/2, we are met with the following warning.
iex> "elixir" |> String.ends_with? "ixir" warning: parentheses are required when piping into a function call. For example: foo 1 |> bar 2 |> baz 3 is ambiguous and should be written as foo(1) |> bar(2) |> baz(3) true