fixup! api: Add as_match method

rust-lang · Sep 20, 2024 · 7311bfc · 7311bfc
1 parent 0fc52dc
commit 7311bfc
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 2 deletions.
diff --git a/src/regex/bytes.rs b/src/regex/bytes.rs
@@ -1668,7 +1668,16 @@ impl<'h> Captures<'h> {
     /// Return the overall match for the capture.
     ///
     /// This returns the match for index `0`. That is it is equivalent to
-    /// `get(0).unwrap()`
+    /// `m.get(0).unwrap()`
+    ///
+    /// ```
+    /// use regex::bytes::Regex;
+    ///
+    /// let re = Regex::new(r"[a-z]+([0-9]+)").unwrap();
+    /// let caps = re.captures(b"   abc123-def").unwrap();
+    ///
+    /// assert_eq!(caps.as_match().as_bytes(), b"abc123");
+    /// ```
     #[inline]
     pub fn as_match(&self) -> Match {
         self.get(0).unwrap()

diff --git a/src/regex/string.rs b/src/regex/string.rs
@@ -1678,7 +1678,17 @@ impl<'h> Captures<'h> {
     /// Return the overall match for the capture.
     ///
     /// This returns the match for index `0`. That is it is equivalent to
-    /// `get(0).unwrap()`
+    /// `m.get(0).unwrap()`
+    ///
+    /// ```
+    /// use regex::Regex;
+    ///
+    /// let re = Regex::new(r"[a-z]+([0-9]+)").unwrap();
+    /// let caps = re.captures("   abc123-def").unwrap();
+    ///
+    /// assert_eq!(caps.as_match().as_str(), "abc123");
+    ///
+    /// ```
     #[inline]
     pub fn as_match(&self) -> Match {
         self.get(0).unwrap()