feat: HugrMut::remove_metadata

CQCL · Oct 30, 2024 · 2c6664b · 2c6664b
1 parent fed74b5
commit 2c6664b
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/hugr-core/src/hugr/hugrmut.rs b/hugr-core/src/hugr/hugrmut.rs
@@ -48,6 +48,19 @@ pub trait HugrMut: HugrMutInternals {
         *entry = metadata.into();
     }
 
+    /// Remove a metadata entry associated with a node.
+    ///
+    /// # Panics
+    ///
+    /// If the node is not in the graph.
+    fn remove_metadata(&mut self, node: Node, key: impl AsRef<str>) {
+        panic_invalid_node(self, node);
+        let node_meta = self.hugr_mut().metadata.get_mut(node.pg_index());
+        if let Some(node_meta) = node_meta {
+            node_meta.remove(key.as_ref());
+        }
+    }
+
     /// Retrieve the complete metadata map for a node.
     fn take_node_metadata(&mut self, node: Node) -> Option<NodeMetadataMap> {
         if !self.valid_node(node) {