Trait Rewrite

pub trait Rewrite {
    type Error: Error;
    type ApplyResult;

    const UNCHANGED_ON_FAILURE: bool;

    // Required methods
    fn verify(&self, h: &impl HugrView) -> Result<(), Self::Error>;
    fn apply(
        self,
        h: &mut impl HugrMut,
    ) -> Result<Self::ApplyResult, Self::Error>;
    fn invalidation_set(&self) -> impl Iterator<Item = Node>;
}

An operation that can be applied to mutate a Hugr

Required Associated Constants

const UNCHANGED_ON_FAILURE: bool

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.

Required Associated Types

type Error: Error

The type of Error with which this Rewrite may fail

type ApplyResult

The type returned on successful application of the rewrite.

Required Methods

fn verify(&self, h: &impl HugrView) -> Result<(), Self::Error>

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, Self::Error>

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]

Panics

May panic if-and-only-if h would have failed Hugr::validate; that is, implementations may begin with assert!(h.validate()), with debug_assert!(h.validate()) being preferred.

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.

Two impl Rewrites can be composed if their invalidation sets are disjoint.

Object Safety

This trait is not object safe.

Implementors

impl Rewrite for RemoveConst

const UNCHANGED_ON_FAILURE: bool = true

type Error = RemoveError

type ApplyResult = Node

impl Rewrite for RemoveLoadConstant

const UNCHANGED_ON_FAILURE: bool = true

type Error = RemoveError

type ApplyResult = Node

impl Rewrite for InlineDFG

const UNCHANGED_ON_FAILURE: bool = true

type ApplyResult = [Node; 3]

type Error = InlineDFGError

impl Rewrite for IdentityInsertion

const UNCHANGED_ON_FAILURE: bool = true

type Error = IdentityInsertionError

type ApplyResult = Node

impl Rewrite for OutlineCfg

const UNCHANGED_ON_FAILURE: bool = true

type Error = OutlineCfgError

type ApplyResult = (Node, Node)

impl Rewrite for Replacement

const UNCHANGED_ON_FAILURE: bool = false

type Error = ReplaceError

type ApplyResult = HashMap<Node, Node>

impl Rewrite for SimpleReplacement

const UNCHANGED_ON_FAILURE: bool = true

type Error = SimpleReplacementError

type ApplyResult = Vec<(Node, OpType)>

impl<R: Rewrite> Rewrite for Transactional<R>

const UNCHANGED_ON_FAILURE: bool = true

type Error = <R as Rewrite>::Error

type ApplyResult = <R as Rewrite>::ApplyResult