Plexus.Budget (Plexus v0.1.0)

Atomic per-run admission ledger.

The ledger tracks logical measure work, expansion work, token usage and live population. Limits may be integers or :infinity.

Summary

limits()

meter()

t()

Record already-consumed work without admission checking (for observed token usage).

new(opts \\ [])

snapshot(budget)

used(map, meter)

@type limits() :: %{optional(meter()) => non_neg_integer() | :infinity}

@type meter() :: :measure | :expand | :tokens | :population

@type t() :: %{atomics: :atomics.atomics_ref(), limits: limits()}

@spec consume(t(), meter(), non_neg_integer()) :: :ok

Record already-consumed work without admission checking (for observed token usage).

@spec new(keyword() | map()) :: t()

@spec refund(t(), meter(), non_neg_integer()) :: :ok

@spec remaining(t(), meter()) :: non_neg_integer() | :infinity

@spec reserve(t(), meter(), non_neg_integer()) :: :ok | {:error, :budget_exhausted}

@spec snapshot(t()) :: map()

@spec transfer(t(), meter(), non_neg_integer(), (-> term())) ::
  {:ok, term()} | {:error, :budget_exhausted}

@spec used(t(), meter()) :: non_neg_integer()