Hafnium (hafnium v0.2.1) View Source

## Example

iex> defmodule Demo do
...>   use Hafnium
...> end
...> 
...> Demo.name
...> ## -> :hafnium_test_demo
...>

Link to this section Summary

Types

input()

invoke_result()

pipe_result()

result()

state()

:ok — success
:error — error
:noop — like ok but do nothing
:fatal — error and break

t()

Base struct

Functions

invoke(o, input)

new(module)

pipeline(module)

Add pipeline

pipeline(module, opts)

Link to this section Types

input()

Specs

input() :: any()

invoke_result()

Specs

invoke_result() :: t() | any()

pipe_result()

Specs

pipe_result() :: t() | pipe_atom_result() | pipe_tuple_result()

result()

Specs

result() :: {state(), any()}

state()

Specs

state() :: :noop | :error | :ok | :fatal

:ok — success
:error — error
:noop — like ok but do nothing
:fatal — error and break

t()

Specs

t() :: %Hafnium{
  __module__: current_module :: module(),
  __pipeline__: Hafnium.Pipeline.t(),
  context: context :: keyword(),
  input: input(),
  pipelines: pipelines :: [Hafnium.Pipeline.t()],
  result: result :: result()
}

Base struct

Link to this section Functions

invoke(o, input)

Specs

invoke(t(), %{}) :: t()

new(module)

Specs

new(atom()) :: %Hafnium{
  __module__: term(),
  __pipeline__: term(),
  context: term(),
  input: term(),
  pipelines: term(),
  result: term()
}

pipeline(module)

(macro)

Add pipeline

defmodule ExampleApi do
  use Elixir.Hafnium

  pipeline MyPipeline1, [foo: :bar]
  pipeline MyPipeline2
end

pipeline(module, opts)

(macro)