Trait HugrInternals

pub trait HugrInternals {
    type RegionPortgraph<'p>: LinkView<LinkEndpoint: Eq> + Clone + 'p
       where Self: 'p;
    type Node: Copy + Ord + Debug + Display + Hash;
    type RegionPortgraphNodes: PortgraphNodeMap<Self::Node>;

    // Required methods
    fn region_portgraph(
        &self,
        parent: Self::Node,
    ) -> (FlatRegion<'_, Self::RegionPortgraph<'_>>, Self::RegionPortgraphNodes);
    fn node_metadata_map(&self, node: Self::Node) -> &NodeMetadataMap;
}

Trait for accessing the internals of a Hugr(View).

Specifically, this trait provides access to the underlying portgraph view.

Required Associated Types

type RegionPortgraph<'p>: LinkView<LinkEndpoint: Eq> + Clone + 'p where Self: 'p

The portgraph graph structure returned by HugrInternals::region_portgraph.

type Node: Copy + Ord + Debug + Display + Hash

The type of nodes in the Hugr.

type RegionPortgraphNodes: PortgraphNodeMap<Self::Node>

A mapping between HUGR nodes and portgraph nodes in the graph returned by HugrInternals::region_portgraph.

Required Methods

fn region_portgraph( &self, parent: Self::Node, ) -> (FlatRegion<'_, Self::RegionPortgraph<'_>>, Self::RegionPortgraphNodes)

Returns a flat portgraph view of a region in the HUGR, and a mapping between HUGR nodes and portgraph nodes in the graph.

fn node_metadata_map(&self, node: Self::Node) -> &NodeMetadataMap

Returns a metadata entry associated with a node.

Panics

If the node is not in the graph.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl<T: HugrView + ToOwned> HugrInternals for Cow<'_, T>

type RegionPortgraph<'p> = <T as HugrInternals>::RegionPortgraph<'p> where Self: 'p

type Node = <T as HugrInternals>::Node

type RegionPortgraphNodes = <T as HugrInternals>::RegionPortgraphNodes

fn region_portgraph( &self, parent: Self::Node, ) -> (FlatRegion<'_, Self::RegionPortgraph<'_>>, Self::RegionPortgraphNodes)

fn node_metadata_map(&self, node: Self::Node) -> &NodeMetadataMap

impl<T: HugrView> HugrInternals for &T

type RegionPortgraph<'p> = <T as HugrInternals>::RegionPortgraph<'p> where Self: 'p

type Node = <T as HugrInternals>::Node

type RegionPortgraphNodes = <T as HugrInternals>::RegionPortgraphNodes

fn region_portgraph( &self, parent: Self::Node, ) -> (FlatRegion<'_, Self::RegionPortgraph<'_>>, Self::RegionPortgraphNodes)

fn node_metadata_map(&self, node: Self::Node) -> &NodeMetadataMap

impl<T: HugrView> HugrInternals for &mut T

type RegionPortgraph<'p> = <T as HugrInternals>::RegionPortgraph<'p> where Self: 'p

type Node = <T as HugrInternals>::Node

type RegionPortgraphNodes = <T as HugrInternals>::RegionPortgraphNodes

fn region_portgraph( &self, parent: Self::Node, ) -> (FlatRegion<'_, Self::RegionPortgraph<'_>>, Self::RegionPortgraphNodes)

fn node_metadata_map(&self, node: Self::Node) -> &NodeMetadataMap

impl<T: HugrView> HugrInternals for Box<T>

type RegionPortgraph<'p> = <T as HugrInternals>::RegionPortgraph<'p> where Self: 'p

type Node = <T as HugrInternals>::Node

type RegionPortgraphNodes = <T as HugrInternals>::RegionPortgraphNodes

fn region_portgraph( &self, parent: Self::Node, ) -> (FlatRegion<'_, Self::RegionPortgraph<'_>>, Self::RegionPortgraphNodes)

fn node_metadata_map(&self, node: Self::Node) -> &NodeMetadataMap

impl<T: HugrView> HugrInternals for Rc<T>

type RegionPortgraph<'p> = <T as HugrInternals>::RegionPortgraph<'p> where Self: 'p

type Node = <T as HugrInternals>::Node

type RegionPortgraphNodes = <T as HugrInternals>::RegionPortgraphNodes

fn region_portgraph( &self, parent: Self::Node, ) -> (FlatRegion<'_, Self::RegionPortgraph<'_>>, Self::RegionPortgraphNodes)

fn node_metadata_map(&self, node: Self::Node) -> &NodeMetadataMap

impl<T: HugrView> HugrInternals for Arc<T>

type RegionPortgraph<'p> = <T as HugrInternals>::RegionPortgraph<'p> where Self: 'p

type Node = <T as HugrInternals>::Node

type RegionPortgraphNodes = <T as HugrInternals>::RegionPortgraphNodes

fn region_portgraph( &self, parent: Self::Node, ) -> (FlatRegion<'_, Self::RegionPortgraph<'_>>, Self::RegionPortgraphNodes)

fn node_metadata_map(&self, node: Self::Node) -> &NodeMetadataMap

Implementors

impl HugrInternals for Hugr

type RegionPortgraph<'p> = &'p MultiPortGraph where Self: 'p

type Node = Node

type RegionPortgraphNodes = DefaultPGNodeMap

impl<H: HugrView> HugrInternals for Rerooted<H>

type RegionPortgraph<'p> = <H as HugrInternals>::RegionPortgraph<'p> where Self: 'p

type Node = <H as HugrInternals>::Node

type RegionPortgraphNodes = <H as HugrInternals>::RegionPortgraphNodes