flexflow v0.1.8

Flexflow.Event behaviour (flexflow v0.1.8) View Source

Event

Link to this section Summary

Types

before_change_result()
edge()
kind()
options()
state()

Event state

t()

Functions

callback(arg1, p, atom, reason)
change(target, e, p)
end?(event)
init(p)
key(map)
new(arg)
start?(event)
validate(events)

Callbacks

before_change({}, t, arg3)

Invoked before event state changes

name()

Module name

Link to this section Types

Link to this type

before_change_result()

View Source

Specs

before_change_result() :: :ok | {:ok, t()} | {:ok, term()} | {:error, term()}
Link to this type

edge()

View Source

Specs

edge() :: {Flexflow.identity(), Flexflow.identity()}
Link to this type

kind()

View Source

Specs

kind() :: :start | :end | :intermediate
Link to this type

options()

View Source

Specs

options() :: Keyword.t()
Link to this type

state()

View Source

Specs

state() :: :error | :pending | :completed | :ready | :initial | :created

Event state

[:created, :initial, :ready, :completed, :pending, :error]

Link to this type

t()

View Source

Specs

t() :: %Flexflow.Event{
  __async__: Keyword.t() | false,
  __context__: Flexflow.Context.t(),
  __graphviz__: Keyword.t(),
  __in_edges__: [edge()],
  __opts__: options(),
  __out_edges__: [edge()],
  kind: kind(),
  module: module(),
  name: Flexflow.name(),
  state: state()
}

Link to this section Functions

Link to this function

callback(arg1, p, atom, reason)

View Source

Specs

callback(Flexflow.identity(), Flexflow.Process.t(), :ok | :error, term()) ::
  Flexflow.Process.result()
Link to this function

change(target, e, p)

View Source

Specs

change(state(), t(), Flexflow.Process.t()) ::
  {:ok, Flexflow.Process.t()} | {:error, term()}
Link to this function

end?(event)

View Source

Specs

end?(t()) :: boolean()
Link to this function

init(p)

View Source

Specs

init(Flexflow.Process.t()) :: Flexflow.Process.t() | {:error, term()}
Link to this function

key(map)

View Source

Specs

key(t()) :: Flexflow.identity()
Link to this function

new(arg)

View Source

Specs

new({Flexflow.identity_or_module(), options()}) :: t()
Link to this function

start?(event)

View Source

Specs

start?(t()) :: boolean()
Link to this function

validate(events)

View Source

Specs

validate([t()]) :: [t()]

Link to this section Callbacks

Link to this callback

before_change({}, t, arg3)

View Source

Specs

before_change({state(), state()}, t(), Flexflow.Process.t()) ::
  before_change_result()

Invoked before event state changes

Link to this callback

name()

View Source

Specs

name() :: Flexflow.name()

Module name