Struct ManagedResourcePool 

pub struct ManagedResourcePool<R, Q = u64>
where
    Q: ResourceQuantity,
{ /* private fields */ }

A cloneable finite pool whose acquired capacity is owned by RAII permits.

Clones share one synchronized capacity state. Dropping a returned ManagedResourcePermit makes its quantity available again, including during early returns and panic unwinding. Use crate::ResourcePool when explicit try_acquire/release pairing is preferred.

Type Parameters

• R - Caller-defined resource value retained for diagnostics.
• Q - Exact unsigned quantity shared by the pool and its permits.

Examples

use qubit_budget::ManagedResourcePool;

let pool = ManagedResourcePool::new("workers", 2_u64);
let permit = pool.try_acquire(1).expect("one worker should fit");
assert_eq!(pool.in_use(), 1);
drop(permit);
assert_eq!(pool.available(), 2);

Implementations

impl<R, Q> ManagedResourcePool<R, Q>

where Q: ResourceQuantity,

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

Creates a managed pool with all finite capacity available.

Parameters

• resource - Resource identity retained in acquisition errors.
• limit - Total finite capacity shared by all handles.

Returns

A new managed pool with limit units available.

pub fn from_limit(limit: ResourceLimit<R, Q>) -> Self

Creates a managed pool from an immutable resource limit.

Parameters

• limit - Resource identity and total finite capacity.

Returns

A new managed pool preserving the supplied limit.

pub fn try_acquire( &self, amount: Q, ) -> Result<ManagedResourcePermit<R, Q>, InsufficientBudgetError<R, Q>>

where R: Clone,

Acquires capacity and returns a permit that releases it on Drop.

Parameters

• amount - Quantity to acquire from current availability.

Returns

A permit owning amount units when they fit.

Errors

Returns InsufficientBudgetError when amount exceeds current availability. Failure leaves the shared pool unchanged. The resource is cloned only after releasing the internal lock.

pub fn resource(&self) -> &R

Returns the resource associated with this shared pool.

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

Returns the immutable resource limit configuring this pool.

pub fn capacity(&self) -> Q

Returns total finite capacity.

pub fn available(&self) -> Q

Returns capacity not currently owned by permits.

pub fn in_use(&self) -> Q

Returns capacity currently owned by permits.

Trait Implementations

impl<R, Q> Clone for ManagedResourcePool<R, Q>

where Q: ResourceQuantity,

fn clone(&self) -> Self

Clones the shared handle without duplicating finite capacity.

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

Performs copy-assignment from source.

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

where Q: ResourceQuantity + Debug,

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

Formats the value using the given formatter.