IVCU v0.2.0

View Source IVCU.CollectionTraverser behaviour (IVCU v0.2.0)

An interface for a strategy that handles applying multiple actions on a collection.

It may be configured via application configuration.

config :ivcu,
  collection_traverser: IVCU.CollectionTraverser.SyncTraverser

The configuration above is default.

Warning

You only need to implement this behaviour if you are not satisfied with already implemented ones. Default is IVCU.CollectionTraverser.SyncTraverser.

Link to this section Summary

Types

result(a, b)

Callbacks

traverse(t, function)

Apply the function to the collection and return result.

Link to this section Types

Link to this type

result(a, b)

View Source

Specs

result(a, b) :: {:ok, a} | {:error, b}

Link to this section Callbacks

Link to this callback

traverse(t, function)

View Source

Specs

traverse(Enumerable.t(), (term() -> result(a, b))) :: result([a], b)
when a: term(), b: term()

Apply the function to the collection and return result.

example

 Example

Imagine we have a module Collection that implements this behaviour. Then we could do the following.

iex(1)> Collection.traverse([1, 2, 3], fn x -> {:ok, x + 1} end)
{:ok, [2, 3, 4]}
iex(2)> Collection.traverse([1, 2, 3], fn x ->
...(2)>   if rem(x, 2) == 0 do
...(2)>     {:error, "#{x} is even"}
...(2)>   else
...(2)>     {:ok, x + 1}
...(2)>   end
...(2)> end)
{:error, "2 is even"}