View Source Euclid.Sugar (Euclid v0.4.0)
Some common syntactic sugar functions.
These functions are intended to be used by importing the functions or the whole module:
import Euclid.Sugar, only: [noreply: 1]
def handle_event("foo", _params, socket) do
socket |> assign(foo: "bar") |> noreply()
endLink to this section Summary
Functions
Wraps a term in an :error tuple. Useful in pipelines.
Unwraps an :error tuple, raising if the term is not an :error tuple
Wraps a term in a :noreply tuple
Wraps a term in an :ok tuple
Unwraps an :ok tuple, raising if the term is not an :ok tuple
Accepts two arguments and returns the second. Useful at the end of the pipeline when you want to return a different value than the last result of the pipeline, such as when the pipeline has side effects and you want to return a different value and you feel the code will be easier to read if everything is in a pipeline.
Link to this section Functions
Specs
Wraps a term in an :error tuple. Useful in pipelines.
Examples
iex> %{} |> Map.put(:count, "unknown") |> Euclid.Sugar.error()
{:error, %{count: "unknown"}}Specs
Unwraps an :error tuple, raising if the term is not an :error tuple
Examples
iex> {:error, 1} |> Euclid.Sugar.error!()
1Specs
Wraps a term in a :noreply tuple
Examples
iex> %{} |> Map.put(:count, 0) |> Euclid.Sugar.noreply()
{:noreply, %{count: 0}}Specs
Wraps a term in an :ok tuple
Examples
iex> %{} |> Map.put(:count, 10) |> Euclid.Sugar.ok()
{:ok, %{count: 10}}Specs
Unwraps an :ok tuple, raising if the term is not an :ok tuple
Examples
iex> {:ok, 1} |> Euclid.Sugar.ok!()
1Specs
Accepts two arguments and returns the second. Useful at the end of the pipeline when you want to return a different value than the last result of the pipeline, such as when the pipeline has side effects and you want to return a different value and you feel the code will be easier to read if everything is in a pipeline.
Examples
iex> %{} |> Map.put(:count, 20) |> Euclid.Sugar.returning(:count_updated)
:count_updated