MingaEditor.Effect.Outcome (Minga v0.1.0)

Copy Markdown View Source

Lifecycle or terminal outcome for an admitted slow effect.

queued and running are lifecycle feedback. canceled, failed, stale, and completed are terminal. Domain handlers may reclassify a completed worker result as stale while atomically applying it to current editor state.

Summary

Types

lifecycle_status()
status()
t()
terminal_status()

Functions

canceled(request, reason)

Builds a canceled terminal candidate.

completed(request, result)

Builds a completed terminal candidate.

failed(request, reason)

Builds a failed terminal candidate.

queued(request, position, total)

Builds a queued lifecycle outcome with scheduler-authored queue metadata.

running(request)

Builds a running lifecycle outcome.

stale(outcome, reason)

Reclassifies an outcome as stale after domain-owned application.

terminal?(outcome)

Returns whether the outcome is terminal.

Types

lifecycle_status()

@type lifecycle_status() :: :queued | :running

status()

@type status() :: lifecycle_status() | terminal_status()

t()

@type t() :: %MingaEditor.Effect.Outcome{
  queue_position: pos_integer() | nil,
  queue_total: pos_integer() | nil,
  reason: term() | nil,
  request: MingaEditor.Effect.Request.t(),
  result: term() | nil,
  status: status()
}

terminal_status()

@type terminal_status() :: :canceled | :failed | :stale | :completed

Functions

canceled(request, reason)

@spec canceled(MingaEditor.Effect.Request.t(), term()) :: t()

Builds a canceled terminal candidate.

completed(request, result)

@spec completed(MingaEditor.Effect.Request.t(), term()) :: t()

Builds a completed terminal candidate.

failed(request, reason)

@spec failed(MingaEditor.Effect.Request.t(), term()) :: t()

Builds a failed terminal candidate.

queued(request, position, total)

@spec queued(MingaEditor.Effect.Request.t(), pos_integer(), pos_integer()) :: t()

Builds a queued lifecycle outcome with scheduler-authored queue metadata.

running(request)

@spec running(MingaEditor.Effect.Request.t()) :: t()

Builds a running lifecycle outcome.

stale(outcome, reason)

@spec stale(t(), term()) :: t()

Reclassifies an outcome as stale after domain-owned application.

terminal?(outcome)

@spec terminal?(t()) :: boolean()

Returns whether the outcome is terminal.