Expose Regex memory usage info (fixes rust-lang#943)

spektom · Apr 5, 2024 · abe60a7 · abe60a7
1 parent 66a3bca
commit abe60a7
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/src/regex/bytes.rs b/src/regex/bytes.rs
@@ -1429,6 +1429,15 @@ impl Regex {
     pub fn locations(&self) -> CaptureLocations {
         self.capture_locations()
     }
+
+    /// Returns the memory usage, in bytes, of this `Regex`.
+    ///
+    /// This does **not** include the stack size used up by this `Regex`.
+    /// To compute that, use `std::mem::size_of::<Regex>()`.
+    #[inline]
+    pub fn memory_usage(&self) -> usize {
+        self.meta.memory_usage()
+    }
 }
 
 /// Represents a single match of a regex in a haystack.

diff --git a/src/regex/string.rs b/src/regex/string.rs
@@ -1432,6 +1432,15 @@ impl Regex {
     pub fn locations(&self) -> CaptureLocations {
         self.capture_locations()
     }
+
+    /// Returns the memory usage, in bytes, of this `Regex`.
+    ///
+    /// This does **not** include the stack size used up by this `Regex`.
+    /// To compute that, use `std::mem::size_of::<Regex>()`.
+    #[inline]
+    pub fn memory_usage(&self) -> usize {
+        self.meta.memory_usage()
+    }
 }
 
 /// Represents a single match of a regex in a haystack.