Struct WorkBudget 

pub struct WorkBudget(/* private fields */);

Byte allowance shared by clones for active buffers and retained reader metadata.

Reservations remain charged until their last handle is dropped, including after request cancellation while blocking work is still running. Cache residency and completed images owned by callers have separate lifetimes and are not covered by this allowance.

Implementations

impl WorkBudget

pub fn new(limit_bytes: u64) -> Self

Create an independent allowance with an exact byte limit. A zero limit permits only zero-byte reservations; it does not disable checks.

pub fn global() -> Self

All default readers/tilers/pools share this 512 MiB working allowance.

pub fn limit_bytes(&self) -> u64

Return the fixed byte limit shared by all clones of this budget.

pub fn used_bytes(&self) -> u64

Snapshot bytes held by live reservations, including retained reader metadata.

pub fn peak_bytes(&self) -> u64

Snapshot the highest reserved byte total since this budget was created.

pub fn try_reserve(&self, bytes: u64) -> AgResult<WorkReservation>

Reserve bytes immediately without waiting. Cloning the returned handle retains the same charge; the final handle’s drop releases it.

Errors

Returns AgError::ResourceLimit when the request exceeds the currently available allowance or the total cannot be represented. No bytes are reserved on failure.

Trait Implementations

impl Clone for WorkBudget

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WorkBudget

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

Formats the value using the given formatter.