Struct hugr_core::hugr::rewrite::insert_identity::IdentityInsertion

pub struct IdentityInsertion {
    pub post_node: Node,
    pub post_port: IncomingPort,
}

Specification of a identity-insertion operation.

Fields

post_node: Node

The node following the identity to be inserted.

post_port: IncomingPort

The port following the identity to be inserted.

Implementations

impl IdentityInsertion

pub fn new(post_node: Node, post_port: IncomingPort) -> Self

Create a new IdentityInsertion specification.

Trait Implementations

impl Clone for IdentityInsertion

fn clone(&self) -> IdentityInsertion

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IdentityInsertion

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

Formats the value using the given formatter.

impl Rewrite for IdentityInsertion

type ApplyResult = Node

The inserted node.

type Error = IdentityInsertionError

The type of Error with which this Rewrite may fail

const UNCHANGED_ON_FAILURE: bool = true

If true, [self.apply]’s of this rewrite guarantee that they do not mutate the Hugr when they return an Err. If false, there is no guarantee; the Hugr should be assumed invalid when Err is returned.

fn verify(&self, _h: &impl HugrView) -> Result<(), IdentityInsertionError>

Checks whether the rewrite would succeed on the specified Hugr. If this call succeeds, [self.apply] should also succeed on the same h If this calls fails, [self.apply] would fail with the same error.

fn apply( self, h: &mut impl HugrMut, ) -> Result<Self::ApplyResult, IdentityInsertionError>

Mutate the specified Hugr, or fail with an error. Returns Self::ApplyResult if successful. If [self.unchanged_on_failure] is true, then h must be unchanged if Err is returned. See also [self.verify]

fn invalidation_set(&self) -> impl Iterator<Item = Node>

Returns a set of nodes referenced by the rewrite. Modifying any of these nodes will invalidate it.