Struct SharedSearchBudget 

pub struct SharedSearchBudget { /* private fields */ }

One forest’s usage behind a shared handle, so the branch tool loops can reserve before every action while the forest holds the same ledgered totals (Gate AC: reservations precede actions; usage never decreases; usage never persists above a limit — overflow clamps at the limit and closes the forest).

Implementations

impl SharedSearchBudget

pub fn new(limits: SearchLimits) -> Self

pub fn with_usage(limits: SearchLimits, usage: SearchUsage) -> Self

Open with prior usage (resume: an interrupted forest’s consumption is not silently forgotten).

pub fn bind_forest(&self, forest_id: &str)

Bind the owning forest’s identity (set once at forest opening).

pub fn set_epoch(&self, epoch: u64)

Advance the identity’s epoch (set at each frontier epoch opening).

pub fn identity(&self) -> (String, u64)

The bound (forest_id, epoch); the forest id is empty outside a forest.

pub fn limits(&self) -> &SearchLimits

pub fn reserve(&self, request: ReservationRequest) -> Result<ReservationTicket>

Reserve one action’s resources before it starts. A refusal marks the handle denied so the forest can abandon the branch gracefully.

pub fn settle( &self, ticket: ReservationTicket, actual: ReservationRequest, ) -> Result<()>

Settle one action: release the unused part of the ticket; charge any overshoot clamped at the limits. Overshoot closes the forest and errs — the caller ledgers the overflow as an observation.

pub fn charge_elapsed(&self, seconds: u64) -> Result<()>

Charge one wall-clock interval, clamped at the limit; crossing it closes the forest.

pub fn headroom(&self, request: &ReservationRequest) -> bool

Non-consuming check: would this reservation be admitted right now?

pub fn snapshot(&self) -> SearchUsage

pub fn close(&self) -> SearchUsage

Terminal snapshot for SearchClosed; the forest cannot reopen.

pub fn is_closed(&self) -> bool

pub fn take_denied(&self) -> bool

Whether a reservation was refused since the last call (one-shot).

Trait Implementations

impl Clone for SharedSearchBudget

fn clone(&self) -> SharedSearchBudget

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SharedSearchBudget

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

Formats the value using the given formatter.