View Source Flamel.Chain (flamel v1.10.0)

Represents a chain of functions that can be executed in a pipeline.

Summary

Types

t()

Flamel.Chain

value()

Functions

apply(context, func)

Applies a function to the value of the chain. If the function returns a {:ok, value} the chain's value is updated. If the function returns a {:error, reason, value} then the chain is halted and not further functions will be applied. The chain's reason will be set to the reason provided in the error tuple.

curry(func)

Creates a function that can be used with Enum.map/1 to build a chain for each item in the enumerable.

new(value)

Create a new chain with a value. The value is the value that the chain's functions are applied to.

to_tuple(chain)
to_value(chain)

Types

Link to this type

t()

View Source 
@type t() :: %Flamel.Chain{assigns: map(), halt?: boolean(), reason: binary()}

Flamel.Chain

Link to this type

value()

View Source 
@type value() :: any()

Functions

Link to this function

apply(context, func)

View Source

Applies a function to the value of the chain. If the function returns a {:ok, value} the chain's value is updated. If the function returns a {:error, reason, value} then the chain is halted and not further functions will be applied. The chain's reason will be set to the reason provided in the error tuple.

Link to this function

curry(func)

View Source 
@spec curry((value() -> value())) :: (value() -> value())

Creates a function that can be used with Enum.map/1 to build a chain for each item in the enumerable.

Link to this function

new(value)

View Source 
@spec new(value()) :: t()

Create a new chain with a value. The value is the value that the chain's functions are applied to.

Link to this function

to_tuple(chain)

View Source 
@spec to_tuple(t()) :: {:ok, value()} | {:error, String.t(), value()}
Link to this function

to_value(chain)

View Source 
@spec to_value(t()) :: value()