Struct Budget 

pub struct Budget { /* private fields */ }

An allowance being drawn down by one operation and everything nested inside it.

Cloning shares the same counters rather than copying them, which is the property that makes limits compose: an operation that calls another passes a clone, and the two draw from one pool. A budget that reset per subsystem would bound each step and nothing overall, which is what having several unrelated local limits already achieved.

Implementations

impl Budget

pub fn new(limits: ResourceLimits) -> Self

A fresh budget against limits.

pub fn with_defaults() -> Self

A fresh budget against ResourceLimits::defaults.

pub const fn limits(&self) -> &ResourceLimits

The limits this budget draws against.

pub fn charge( &self, resource: Resource, amount: u64, ) -> Result<(), LimitExceeded>

Charge amount against resource.

Errors

Returns LimitExceeded naming resource and its bound when the charge would take the total past it. The amount is still recorded, so a caller that ignores one failure and continues does not find the next charge succeeding.

pub const fn enter(&self, level: u64) -> Result<(), LimitExceeded>

Check that level is within the depth bound.

Errors

Returns LimitExceeded for Resource::Depth when level is past the bound.

pub fn consumed(&self, resource: Resource) -> u64

How much of resource has been charged so far.

Trait Implementations

impl Clone for Budget

fn clone(&self) -> Budget

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Budget

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

Formats the value using the given formatter.

impl Default for Budget

fn default() -> Self

Returns the “default value” for a type.