Jido.Exec.Execution (Jido Action v3.0.0-beta.12)

View Source

State for a paused Flow execution.

Create an execution with Jido.Exec.start/4. Pass the latest returned value to the other step-wise execution functions. Use Jido.Exec functions to read or update it. Its fields are internal, and the value is not a storage or interchange format. A successful state-changing operation consumes its revision. Jido rejects concurrent use and reuse of an older revision before it dispatches Action work. Use Jido.Exec.continue/1 to finish the lifecycle.

Summary

Types

t()

State for one in-memory Flow execution session.

Types

t()

@type t() :: %Jido.Exec.Execution{
  compiled: Jido.Flow.Compiled.t(),
  context: map(),
  engine_error: Exception.t() | nil,
  final_result:
    {:ok, term()}
    | {:ok, term(), Jido.Action.effects()}
    | {:error, Exception.t()}
    | nil,
  finalizer: (term() -> {:ok, term()} | {:error, Exception.t()}) | nil,
  flow_name: String.t(),
  guard: :atomics.atomics_ref(),
  id: String.t(),
  input: map(),
  lifecycle: %{flow: map()},
  options: keyword(),
  ready: [Runic.Workflow.Runnable.t()],
  revision: non_neg_integer(),
  runnable_errors: [
    %{node: String.t() | atom(), runnable_id: term(), error: Exception.t()}
  ],
  status: :running | :succeeded | :failed,
  work_ref: reference(),
  workflow: Runic.Workflow.t()
}

State for one in-memory Flow execution session.