Struct ResourceManager 

pub struct ResourceManager { /* private fields */ }

Tracks compiler-visible logical qubits and temporary ancillary-resource leases.

A manager is created from one circuit and must remain synchronized with that circuit. It separates resource selection from mutation: Self::preview returns a side-effect-free candidate, while Self::commit reserves the selected qubits and adds any planned pre-layout logical ancillas to the circuit. The caller must satisfy the lease’s restoration contract before calling Self::release.

The manager records contracts and resource ownership only. It does not analyze quantum state or prove that a consuming transform restored leased qubits correctly.

Implementations

impl ResourceManager

pub fn from_circuit( circuit: &Circuit, policy: ResourcePolicy, limits: ResourceLimits, ) -> Result<Self, ResourceError>

Creates a pre-layout resource manager for the circuit’s current qubits.

Existing circuit qubits are registered as input resources. They are not assumed to be clean at an arbitrary compiler boundary, but may later be borrowed for a dirty request when permitted by ResourcePolicy.

The returned manager must be used with this circuit as both evolve.

Errors

Returns ResourceError::CapacityExceeded when the input circuit already exceeds limits, or ResourceError::CounterOverflow if an internal manager identifier cannot be allocated.

pub fn preview( &self, request: &ResourceRequest, ) -> Result<ResourcePlan, ResourceError>

Returns a side-effect-free resource preview for an algorithm candidate.

Preview and commit are separate so a planner can compare feasible algorithms without mutating the circuit or reserving resources. A clean request may plan fresh logical ancillas before layout. A dirty request only reuses registered resources and never plans fresh qubits.

Qubits listed in ResourceRequest::excluded are never selected. The returned plan is tied to this manager’s current revision and becomes stale after a successful commit, release, or phase transition.

Errors

Returns ResourceError::InvalidRequest for malformed requests, ResourceError::InsufficientResources when the active policy cannot satisfy the request, ResourceError::CapacityExceeded when new clean qubits would exceed the configured total, or ResourceError::QubitIdOverflow when no new logical identifier can be represented.

pub fn commit( &mut self, circuit: &mut Circuit, plan: ResourcePlan, ) -> Result<ResourceLease, ResourceError>

Commits a previously previewed resource selection.

The plan must come from this manager’s current revision. Successful commits add any planned clean logical qubits to circuit atomically, reserve all selected qubits, and return a lease that must later be passed to Self::release. While the lease is active, its qubits cannot be selected by another plan.

Errors

Returns ResourceError::ForeignPlan for a plan created by another manager, ResourceError::StalePlan for an outdated preview, or a consistency, phase, capacity, or counter error when the commit cannot be applied atomically.

pub fn release(&mut self, lease: &ResourceLease) -> Result<(), ResourceError>

Releases a completed ancillary-resource lease.

The consuming algorithm must satisfy its restoration contract before calling this method. The manager records that contract but cannot prove the algorithm’s quantum semantics. Released qubits remain registered and may satisfy later requests; releasing a lease does not remove qubits from the circuit.

Errors

Returns ResourceError::UnknownLease when the lease belongs to another manager, has already been released, or does not match the active record. Returns a consistency or counter error if internal indexes cannot be updated safely.

pub fn enter_post_layout( &mut self, circuit: &Circuit, ) -> Result<(), ResourceError>

Enters the phase where all reusable logical ancillary qubits must already be backed by a layout mapping.

The transition is one-way and requires an idle, consistent manager. After this call, previews may reuse existing compiler-allocated ancillas but may not plan fresh logical qubits.

Errors

Returns ResourceError::InvalidPhase unless the manager is currently pre-layout, or a consistency or idle error when the circuit is not at a valid layout boundary.

pub fn verify_consistency(&self, circuit: &Circuit) -> Result<(), ResourceError>

Checks that the circuit and all resource-manager indexes agree.

This verifies structural bookkeeping only. It does not inspect quantum state or establish that active consumers will satisfy their restoration contracts.

Errors

Returns ResourceError::CircuitResourceMismatch when a circuit qubit, resource record, or lease index is inconsistent.

pub fn verify_idle(&self, circuit: &Circuit) -> Result<(), ResourceError>

Checks resource indexes and requires every temporary lease to be released.

Compiler stages should use this at boundaries where no algorithm may retain temporary ancillary resources, including before entering post-layout and after resource-consuming transformations complete.

Errors

Returns the consistency errors documented by Self::verify_consistency, or ResourceError::ActiveLeaseRemaining while any lease remains active.

Trait Implementations

impl Debug for ResourceManager

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

Formats the value using the given formatter.