Add method to get full match from Captures #1146
Description
Describe your feature request
Add a method to regex::Captures that is equvalent to (or even just this implementation):
#[inline]
fn full_match(&self) -> Match<'h'> {
self.get(0).unwrap()
}Getting the full match is a very common operation, and although the documetation for Regex::get says that getting the result at index 0 will always return Some, that property isn't reflected in the type system. And adding a method like this would expose that guarantee through the type of the public API.
Metadata
Metadata
Assignees
Type
Projects
Milestone
Relationships
Development
Participants
Activity
BurntSushi commentedon Jan 9, 2024
I think this is probably a good idea. I added an analogous method (among others) to the lower level
regex-automata::util::captures::Capturestype.I'm not sure
full_matchis the right name though. Hmmm. I'm not a huge fan ofget_matcheither in this context. Probablymatchwould be ideally, except for the obvious drawback thatmatchis a Rust keyword.tmccombs commentedon Jan 9, 2024
Yeah, I'm not sure
full_matchis a great name either, but I couldn't think of a better one.ultrabear commentedon Jul 15, 2024
A potential other name could be
as_matchregex: add as_match method to Captures trait