Struct Fuel 

pub struct Fuel { /* private fields */ }

A decrementing resource budget shared across algorithm invocations.

Clone produces a new handle to the same underlying counter; consumption on any clone is observed by all clones. Use this to thread a single budget through nested calls without passing &Fuel everywhere.

Implementations

impl Fuel

pub fn new(budget: usize) -> Self

Create a new budget with budget units.

pub fn consume(&self, n: usize)

Consume n units. If the remaining budget would drop to zero or below, the counter saturates at zero (subsequent Self::check fails). This call is infallible — query the outcome with Self::check or read the residual via Self::remaining.

pub fn check(&self) -> Result<()>

Return Ok(()) if budget remains, Err(OutOfFuel) otherwise. Cheap hot-path probe; use between small units of work to avoid an explicit Self::consume on every iteration.

pub fn remaining(&self) -> usize

The number of units still available. 0 means exhausted.

Trait Implementations

impl Clone for Fuel

fn clone(&self) -> Fuel

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Fuel

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

Formats the value using the given formatter.

impl Default for Fuel

fn default() -> Self

Returns the “default value” for a type.