Struct ResourceLimit 

pub struct ResourceLimit<R, Q = u64>
where
    Q: Copy + Debug,
{ /* private fields */ }

An inclusive immutable maximum for one resource measurement.

Type Parameters

• R - Caller-defined resource value retained in limit failures.
• Q - Copyable measurement value used by the maximum and checks.

Examples

use qubit_budget::ResourceLimit;

let limit = ResourceLimit::new("payload bytes", 8_u64);
limit.check(8).expect("the inclusive maximum should fit");
assert!(limit.check(9).is_err());

Implementations

impl<R, Q> ResourceLimit<R, Q>

where Q: Copy + Debug,

pub const fn new(resource: R, maximum: Q) -> Self

Creates an immutable limit bound to resource.

Parameters

• resource - Domain resource reported when the limit is exceeded.
• maximum - Inclusive maximum measurement accepted by Self::check.

Returns

A limit that accepts measurements less than or equal to maximum.

pub const fn resource(&self) -> &R

Returns the resource bound to this limit.

Returns

Returns the resource bound to this limit.

pub const fn maximum(&self) -> Q

Returns this limit’s inclusive maximum measurement.

Returns

Returns this limit’s inclusive maximum measurement.

pub fn check(&self, actual: Q) -> Result<(), LimitExceededError<R, Q>>

where R: Clone, Q: Ord,

Checks whether actual is within the inclusive maximum.

Parameters

• actual - Observed measurement to validate.

Returns

Ok(()) when actual <= maximum; otherwise returns LimitExceededError containing the resource, observed value, and maximum. This method does not mutate the limit.

Errors

Returns LimitExceededError when actual is greater than this limit’s maximum.

impl<R, Q> ResourceLimit<R, Q>

where Q: ResourceQuantity,

pub fn check_usize( &self, actual: usize, ) -> Result<(), MeasuredBudgetError<R, Q>>

where R: Clone,

Checks a machine-sized measurement without truncating it.

Parameters

• actual - Native measurement to convert and compare with the limit.

Returns

Ok(()) when the converted measurement fits this limit.

Errors

Returns MeasuredBudgetError::Quantity when actual cannot be represented by Q, or MeasuredBudgetError::Budget when the converted value exceeds this limit.

pub fn check_u64(&self, actual: u64) -> Result<(), MeasuredBudgetError<R, Q>>

where R: Clone,

Checks a 64-bit measurement without truncating it.

Parameters

• actual - 64-bit measurement to convert and compare with the limit.

Returns

Ok(()) when the converted measurement fits this limit.

Errors

Returns MeasuredBudgetError::Quantity when actual cannot be represented by Q, or MeasuredBudgetError::Budget when the converted value exceeds this limit.

Trait Implementations

impl<R: Clone, Q> Clone for ResourceLimit<R, Q>

where Q: Copy + Debug + Clone,

fn clone(&self) -> ResourceLimit<R, Q>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<R: Copy, Q> Copy for ResourceLimit<R, Q>

where Q: Copy + Debug + Copy,

impl<R: Debug, Q> Debug for ResourceLimit<R, Q>

where Q: Copy + Debug + Debug,

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

Formats the value using the given formatter.

impl<R: Eq, Q> Eq for ResourceLimit<R, Q>

where Q: Copy + Debug + Eq,

impl<R: Hash, Q> Hash for ResourceLimit<R, Q>

where Q: Copy + Debug + Hash,

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<R: PartialEq, Q> PartialEq for ResourceLimit<R, Q>

where Q: Copy + Debug + PartialEq,

fn eq(&self, other: &ResourceLimit<R, Q>) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<R: PartialEq, Q> StructuralPartialEq for ResourceLimit<R, Q>

where Q: Copy + Debug + PartialEq,