Trait HugrInternals

pub trait HugrInternals {
    type Portgraph<'p>: LinkView + Clone + 'p
       where Self: 'p;
    type Node: Copy + Ord + Debug + Display + Hash;

    // Required methods
    fn portgraph(&self) -> Self::Portgraph<'_>;
    fn base_hugr(&self) -> &Hugr;
    fn root_node(&self) -> Self::Node;
    fn get_pg_index(&self, node: Self::Node) -> NodeIndex;
    fn get_node(&self, index: NodeIndex) -> Self::Node;

    // Provided method
    fn hierarchy(&self) -> Cow<'_, Hierarchy> { ... }
}

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

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

Required Associated Types

type Portgraph<'p>: LinkView + Clone + 'p where Self: 'p

The underlying portgraph view type.

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

The type of nodes in the Hugr.

Required Methods

fn portgraph(&self) -> Self::Portgraph<'_>

Returns a reference to the underlying portgraph.

fn base_hugr(&self) -> &Hugr

Returns the Hugr at the base of a chain of views.

fn root_node(&self) -> Self::Node

Return the root node of this view.

fn get_pg_index(&self, node: Self::Node) -> NodeIndex

Convert a node to a portgraph node index.

fn get_node(&self, index: NodeIndex) -> Self::Node

Convert a portgraph node index to a node.

Provided Methods

fn hierarchy(&self) -> Cow<'_, Hierarchy>

Returns the portgraph Hierarchy of the graph returned by HugrInternals::portgraph.

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: HugrInternals + ToOwned> HugrInternals for Cow<'_, T>

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

type Node = <T as HugrInternals>::Node

fn portgraph(&self) -> Self::Portgraph<'_>

fn hierarchy(&self) -> Cow<'_, Hierarchy>

fn base_hugr(&self) -> &Hugr

fn root_node(&self) -> Self::Node

fn get_pg_index(&self, node: Self::Node) -> NodeIndex

fn get_node(&self, index: NodeIndex) -> Self::Node

impl<T: HugrInternals> HugrInternals for &T

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

type Node = <T as HugrInternals>::Node

fn portgraph(&self) -> Self::Portgraph<'_>

fn hierarchy(&self) -> Cow<'_, Hierarchy>

fn base_hugr(&self) -> &Hugr

fn root_node(&self) -> Self::Node

fn get_pg_index(&self, node: Self::Node) -> NodeIndex

fn get_node(&self, index: NodeIndex) -> Self::Node

impl<T: HugrInternals> HugrInternals for &mut T

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

type Node = <T as HugrInternals>::Node

fn portgraph(&self) -> Self::Portgraph<'_>

fn hierarchy(&self) -> Cow<'_, Hierarchy>

fn base_hugr(&self) -> &Hugr

fn root_node(&self) -> Self::Node

fn get_pg_index(&self, node: Self::Node) -> NodeIndex

fn get_node(&self, index: NodeIndex) -> Self::Node

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

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

type Node = <T as HugrInternals>::Node

fn portgraph(&self) -> Self::Portgraph<'_>

fn hierarchy(&self) -> Cow<'_, Hierarchy>

fn base_hugr(&self) -> &Hugr

fn root_node(&self) -> Self::Node

fn get_pg_index(&self, node: Self::Node) -> NodeIndex

fn get_node(&self, index: NodeIndex) -> Self::Node

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

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

type Node = <T as HugrInternals>::Node

fn portgraph(&self) -> Self::Portgraph<'_>

fn hierarchy(&self) -> Cow<'_, Hierarchy>

fn base_hugr(&self) -> &Hugr

fn root_node(&self) -> Self::Node

fn get_pg_index(&self, node: Self::Node) -> NodeIndex

fn get_node(&self, index: NodeIndex) -> Self::Node

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

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

type Node = <T as HugrInternals>::Node

fn portgraph(&self) -> Self::Portgraph<'_>

fn hierarchy(&self) -> Cow<'_, Hierarchy>

fn base_hugr(&self) -> &Hugr

fn root_node(&self) -> Self::Node

fn get_pg_index(&self, node: Self::Node) -> NodeIndex

fn get_node(&self, index: NodeIndex) -> Self::Node

Implementors

impl HugrInternals for Hugr

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

type Node = Node

impl<'g, Root> HugrInternals for DescendantsGraph<'g, Root>

where Root: NodeHandle,

type Portgraph<'p> = &'p Region<'g, &'g MultiPortGraph> where Self: 'p

type Node = Node

impl<'g, Root> HugrInternals for SiblingGraph<'g, Root>

where Root: NodeHandle,

type Portgraph<'p> = &'p FlatRegion<'g, &'g MultiPortGraph> where Self: 'p

type Node = Node

impl<'g, Root: NodeHandle> HugrInternals for SiblingMut<'g, Root>

type Portgraph<'p> = FlatRegion<'p, &'p MultiPortGraph> where Root: 'p, 'g: 'p

type Node = Node

impl<H: AsRef<Hugr>, Root> HugrInternals for RootChecked<H, Root>

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

type Node = Node