Struct Governor 

pub struct Governor {
    pub waiting: BTreeMap<String, u64>,
    /* private fields */
}

The governor: the instance scope + named sub-scopes.

Fields

waiting: BTreeMap<String, u64>

Units currently waiting on the budget (for the gauge / status).

Implementations

impl Governor

pub fn new(budget: &Budget) -> Governor

pub fn is_active(&self) -> bool

Whether any budget is configured at all (else admission is trivially ok).

pub fn ensure_scope(&mut self, key: &str, budget: &Budget)

Ensure a sub-scope exists (e.g. conversation:<id>, run:<id>).

pub fn drop_scope(&mut self, key: &str)

pub fn admit( &mut self, estimate: u64, scopes: &[String], now_ms: u64, ) -> Admission

Ask to spend estimate tokens now, under the instance scope and the named sub-scopes (scopes must exist via ensure_scope). On Ok the estimate is reserved until Governor::settle / Governor::release.

pub fn settle(&mut self, reservation: u64, usage: Usage)

Settle a reservation with the reported usage.

pub fn charge(&mut self, usage: Usage, scopes: &[String])

Charge usage that had no reservation (a child reported more calls than admissions, or admission is off).

pub fn release(&mut self, reservation: u64)

Release a reservation without usage (the unit never ran).

pub fn to_value(&self) -> Value

The durable counters (manifest budget).

pub fn restore(&mut self, v: &Value, now_ms: u64)

Adopt restored counters (matching windows by unit; scopes by key when they exist — a scope restored before ensure_scope is kept aside).

pub fn status(&self, now_ms: u64) -> Value

agent://budget.

pub fn lifetime_used(&self) -> u64

The instance-scope lifetime usage.

pub fn next_reset_ms(&self, now_ms: u64) -> Option<u64>

The earliest moment any exhausted instance window opens again.

Trait Implementations

impl Clone for Governor

fn clone(&self) -> Governor

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Governor

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.