Implement Debug for NetRef (#40)

Author: matth2k

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "safety-net"
-version = "0.1.6"
+version = "0.1.7"
 edition = "2024"
 license = "MIT OR Apache-2.0"
 

README.md

@@ -6,7 +6,7 @@
 
 ## Description
 
-A Rust library for compiling and mutating Safety Net netlists in a memory-safe way
+A Rust library for compiling and mutating netlists in a memory-safe way
 
 You can read the docs [here](https://matth2k.github.io/safety-net/).
 

src/netlist.rs

@@ -432,14 +432,33 @@ type NetRefT<I> = Rc<RefCell<OwnedObject<I, Netlist<I>>>>;
 
 /// Provides an idiomatic interface
 /// to the interior mutability of the netlist
-#[derive(Debug, Clone)]
+#[derive(Clone)]
 pub struct NetRef<I>
 where
     I: Instantiable,
 {
     netref: NetRefT<I>,
 }
 
+impl<I> std::fmt::Debug for NetRef<I>
+where
+    I: Instantiable,
+{
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        let b = self.netref.borrow();
+        let o = b.get();
+        let i = b.index;
+        let owner = &b.owner;
+        match owner.upgrade() {
+            Some(owner) => {
+                let n = owner.get_name();
+                write!(f, "{{ owner: \"{n}\", index: {i}, val: \"{o}\" }}")
+            }
+            None => write!(f, "{{ owner: None, index: {i}, val: \"{o}\" }}"),
+        }
+    }
+}
+
 impl<I> PartialEq for NetRef<I>
 where
     I: Instantiable,

tests/api.rs

@@ -62,6 +62,17 @@ fn get_simple_example() -> Rc<GateNetlist> {
     netlist
 }
 
+#[test]
+fn test_netref_printing() {
+    let netlist = get_simple_example();
+    let gate = netlist.last().unwrap();
+    let output = format!("{gate:?}");
+    assert_eq!(
+        output,
+        "{ owner: \"example\", index: 2, val: \"AND(inst_0)\" }"
+    );
+}
+
 #[test]
 fn test_io() {
     let netlist = get_simple_example();