duct v1.0.3

View Source Duct.Multi (duct v1.0.3)

Base on code of Ecto.Multi in here https://github.com/elixir-ecto/ecto/blob/b0e598926180e0788b4809dffd691bd0b5b54e81/lib/ecto/multi.ex

Link to this section Summary

Types

changes()
name()
run()
t()

Functions

inspect(multi, opts \\ [])
new()

Returns an empty Duct.Multi struct.

run(multi, name, run)

Adds a function to run as part of the multi.

to_list(multi)

Returns the list of operations stored in multi.

Link to this section Types

Link to this type

changes()

View Source 
@type changes() :: map()
Link to this type

name()

View Source 
@type name() :: any()
Link to this type

run()

View Source 
@type run() :: (changes() -> {:ok | :error, any()} | any())
Link to this type

t()

View Source 
@type t() :: %Duct.Multi{names: names(), operations: operations()}

Link to this section Functions

Link to this function

inspect(multi, opts \\ [])

View Source 
@spec inspect(t(), Keyword.t()) :: t()
Link to this function

new()

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

Returns an empty Duct.Multi struct.

example

 Example 

iex> Duct.Multi.new() |> Duct.Multi.to_list()
[]
Link to this function

run(multi, name, run)

View Source 
@spec run(t(), name(), run()) :: t()

Adds a function to run as part of the multi.

example

 Example 

Duct.Multi.new()
|> Duct.Multi.run("salary", fn _ -> 1_000_000 end)
|> Duct.Multi.run("tax", fn %{"salary" => salary} -> salary * 10 / 100 end)
|> Duct.run()
Link to this function

to_list(multi)

View Source 
@spec to_list(t()) :: [{name(), term()}]

Returns the list of operations stored in multi.

Always use this function when you need to access the operations you have defined in Duct.Multi. Inspecting the Duct.Multi struct internals directly is discouraged.