added ref<T>::reset() function

wjakob · Oct 4, 2023 · 8bd58c7 · 8bd58c7
1 parent cc5ac7e
commit 8bd58c7
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/docs/api_extra.rst b/docs/api_extra.rst
@@ -1146,6 +1146,11 @@ functions:
 
       Overwrite this reference with a pointer to another object
 
+   .. cpp:function:: void reset()
+
+      Clear the reference and reduces the reference count of the object (if not
+      ``nullptr``)
+
    .. cpp:function:: bool operator==(const ref &r) const
 
       Compare this reference with another reference (pointer equality)

diff --git a/include/nanobind/intrusive/ref.h b/include/nanobind/intrusive/ref.h
@@ -73,6 +73,12 @@ template <typename T> class ref {
         return *this;
     }
 
+    /// Clear the currently stored reference
+    void reset() {
+        dec_ref(m_ptr);
+        m_ptr = nullptr;
+    }
+
     /// Compare this reference with another reference
     bool operator==(const ref &r) const { return m_ptr == r.m_ptr; }