MingaEditor.State.OperationQueue (Minga v0.1.0)

Copy Markdown View Source

Scheduler-authored queue position metadata for an operation.

Summary

Functions

Builds queue metadata when the position is within the positive wire-safe queue total.

Builds valid queue metadata or raises for an impossible range.

Types

error()

@type error() :: :invalid_queue_range

t()

@type t() :: %MingaEditor.State.OperationQueue{
  position: pos_integer(),
  total: pos_integer()
}

Functions

new(position, total)

@spec new(integer(), integer()) :: {:ok, t()} | {:error, error()}

Builds queue metadata when the position is within the positive wire-safe queue total.

new!(position, total)

@spec new!(integer(), integer()) :: t()

Builds valid queue metadata or raises for an impossible range.