Struct ConditionalBuilder

pub struct ConditionalBuilder<T> { /* private fields */ }

Builder for a ops::Conditional node’s children.

Implementations

impl<B: AsMut<Hugr> + AsRef<Hugr>> ConditionalBuilder<B>

pub fn case_builder( &mut self, case: usize, ) -> Result<CaseBuilder<&mut Hugr>, BuildError>

Return a builder the Case node with index case.

Panics

Panics if the parent node is not of type ops::Conditional.

Errors

This function will return an error if the case has already been built, case is not a valid index or if there is an error adding nodes.

impl ConditionalBuilder<Hugr>

pub fn new( sum_rows: impl IntoIterator<Item = TypeRow>, other_inputs: impl Into<TypeRow>, outputs: impl Into<TypeRow>, ) -> Result<Self, BuildError>

Initialize a Conditional rooted HUGR builder.

Trait Implementations

impl<T: Clone> Clone for ConditionalBuilder<T>

fn clone(&self) -> ConditionalBuilder<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: AsMut<Hugr> + AsRef<Hugr>> Container for ConditionalBuilder<T>

fn container_node(&self) -> Node

The container node.

fn hugr_mut(&mut self) -> &mut Hugr

The underlying Hugr being built

fn hugr(&self) -> &Hugr

Immutable reference to HUGR being built

fn add_child_node(&mut self, node: impl Into<OpType>) -> Node

Add an OpType as the final child of the container.

fn add_other_wire(&mut self, src: Node, dst: Node) -> Wire

Adds a non-dataflow edge between two nodes. The kind is given by the operation’s other_inputs or other_outputs

fn add_constant(&mut self, constant: impl Into<Const>) -> ConstID

Add a constant value to the container and return a handle to it.

fn add_hugr(&mut self, child: Hugr) -> InsertionResult

Insert a HUGR as a child of the container.

fn add_hugr_view<H: HugrView>( &mut self, child: &H, ) -> InsertionResult<H::Node, Node>

Insert a copy of a HUGR as a child of the container.

fn set_metadata(&mut self, key: impl AsRef<str>, meta: impl Into<NodeMetadata>)

Add metadata to the container node.

fn set_child_metadata( &mut self, child: Node, key: impl AsRef<str>, meta: impl Into<NodeMetadata>, )

Add metadata to a child node.

fn use_extension(&mut self, ext: impl Into<Arc<Extension>>)

Add an extension to the set of extensions used by the hugr.

fn use_extensions<Reg>(&mut self, registry: impl IntoIterator<Item = Reg>)

where ExtensionRegistry: Extend<Reg>,

Extend the set of extensions used by the hugr with the extensions in the registry.

impl<T: Debug> Debug for ConditionalBuilder<T>

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

Formats the value using the given formatter.

impl HugrBuilder for ConditionalBuilder<Hugr>

fn finish_hugr(self) -> Result<Hugr, ValidationError<Node>>

Finish building the HUGR, perform any validation checks and return it.

fn module_root_builder(&mut self) -> ModuleBuilder<&mut Hugr>

Allows adding definitions to the module root of which this builder is building a part

impl<T: PartialEq> PartialEq for ConditionalBuilder<T>

fn eq(&self, other: &ConditionalBuilder<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<H: AsMut<Hugr> + AsRef<Hugr>> SubContainer for ConditionalBuilder<H>

type ContainerHandle = BuildHandle<ConditionalID>

A handle to the finished container node, typically returned when the child graph has been finished.

fn finish_sub_container(self) -> Result<Self::ContainerHandle, BuildError>

Consume the container builder and return the handle, may perform some checks before finishing.

impl<T> StructuralPartialEq for ConditionalBuilder<T>