Struct BloqTemplatePool 

pub struct BloqTemplatePool { /* private fields */ }

A shared, append-only template pool.

Templates are keyed by TemplateId (the insertion index). Ids are never reused or renumbered, so anything that stores a TemplateId outside the pool — crate::PipePadding, the decoder-wait specialization memo — can rely on it staying valid for the program’s life.

Implementations

impl BloqTemplatePool

pub fn new() -> Self

Create an empty template pool.

pub fn insert(&mut self, template: BloqTemplate) -> TemplateId

Insert an owned template and return its append-only id.

Panics

Panics before insertion if the next id exceeds u32.

pub fn insert_shared(&mut self, template: Arc<BloqTemplate>) -> TemplateId

Unlike Self::insert, warmed qubit, circuit-analysis, and validation caches are kept: an Arc-shared template is already immutable (the pool hands out no &mut), so they cannot be stale. Clearing them here would deep-clone every template the caller shares with a live pool.

Panics

Panics before insertion if the next id exceeds u32.

pub fn get(&self, id: TemplateId) -> Option<&BloqTemplate>

Look up a template by id.

pub fn iter(&self) -> impl Iterator<Item = (TemplateId, &BloqTemplate)>

Iterate over templates in id order.

pub fn iter_shared( &self, ) -> impl Iterator<Item = (TemplateId, &Arc<BloqTemplate>)>

Borrow immutable template handles for importing into another pool without copying their circuits or discarding cached analyses.

pub fn len(&self) -> usize

Number of templates.

pub fn is_empty(&self) -> bool

Whether the pool contains no templates.

Trait Implementations

impl Clone for BloqTemplatePool

fn clone(&self) -> BloqTemplatePool

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BloqTemplatePool

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

Formats the value using the given formatter.

impl Default for BloqTemplatePool

fn default() -> BloqTemplatePool

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for BloqTemplatePool

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Index<TemplateId> for BloqTemplatePool

type Output = BloqTemplate

The returned type after indexing.

fn index(&self, index: TemplateId) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Serialize for BloqTemplatePool

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.