Struct BudgetWatch 

pub struct BudgetWatch { /* private fields */ }

One-shot wall-clock deadline for a single search invocation.

Create with BudgetWatch::start at the beginning of search and call BudgetWatch::check after each counted expansion when the node is not the goal (or before continuing after an expansion that did not finish the search).

Implementations

impl BudgetWatch

pub fn start(budget: SearchBudget) -> Self

Captures the wall-clock deadline for budget (if any).

pub const fn budget(&self) -> SearchBudget

Returns the budget this watch was started with.

pub const fn is_unlimited(&self) -> bool

Fast path when both caps are unset.

pub fn check(&self, expansions: usize) -> Result<(), BudgetExhausted>

Checks expansion and wall-clock caps against the work done so far.

Call after incrementing the expansion counter when the search has not yet terminated as found. Unlimited budgets always return Ok(()).

Expansion semantics: after expansions counted nodes, if expansions >= max_expansions the budget is exhausted (the caller should only invoke this when the current node is not an accepted goal).

pub const fn has_limits(&self) -> bool

Whether any budget limit is configured (used to skip watch setup cost).

Trait Implementations

impl Clone for BudgetWatch

fn clone(&self) -> BudgetWatch

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for BudgetWatch

impl Debug for BudgetWatch

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

Formats the value using the given formatter.