api: Add as_match method #1227
Open
api: Add as_match method #1227
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
To simplify getting the whole match from Captures
BurntSushi
requested changes
Sep 19, 2024
src/regex/bytes.rs
Outdated
| /// Return the overall match for the capture. | ||
| /// | ||
| /// This returns the match for index `0`. That is it is equivalent to | ||
| /// `get(0).unwrap()` |
There was a problem hiding this comment.
Can you use m.get(0).unwrap()?
| @@ -1665,6 +1665,15 @@ impl<'h> Captures<'h> { | |||
| .map(|sp| Match::new(self.haystack, sp.start, sp.end)) | |||
| } | |||
|
|
|||
| /// Return the overall match for the capture. | |||
There was a problem hiding this comment.
Please add an example. I try to include an example for every public API item.
BurntSushi
requested changes
Sep 29, 2024
| /// let caps = re.captures(b" abc123-def").unwrap(); | ||
| /// | ||
| /// assert_eq!(caps.as_match().as_bytes(), b"abc123"); | ||
| /// ``` |
There was a problem hiding this comment.
This example is not formatted in the same way as all other examples.
Please look at other public API items and format this one in the same way. It should have an # Example heading, for example.
|
Also, I think the name |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
To simplify getting the whole match from Captures
Fixes #1146