Struct grep_regex::RegexCaptures

pub struct RegexCaptures(_);

Represents the match offsets of each capturing group in a match.

The first, or 0th capture group, always corresponds to the entire match and is guaranteed to be present when a match occurs. The next capture group, at index 1, corresponds to the first capturing group in the regex, ordered by the position at which the left opening parenthesis occurs.

Note that not all capturing groups are guaranteed to be present in a match. For example, in the regex, (?P<foo>\w)|(?P<bar>\W), only one of foo or bar will ever be set in any given match.

In order to access a capture group by name, you'll need to first find the index of the group using the corresponding matcher's capture_index method, and then use that index with RegexCaptures::get.

Trait Implementations

impl Clone for RegexCaptures

fn clone(&self) -> RegexCaptures

Returns a copy of the value.

default fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RegexCaptures

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Captures for RegexCaptures

fn len(&self) -> usize

Return the total number of capturing groups. This includes capturing groups that have not matched anything.

fn get(&self, i: usize) -> Option<Match>

Return the capturing group match at the given index. If no match of that capturing group exists, then this returns None.

default fn is_empty(&self) -> bool

Returns true if and only if these captures are empty. This occurs when len is 0.

default fn interpolate<F>(
    &self,
    name_to_index: F,
    haystack: &[u8],
    replacement: &[u8],
    dst: &mut Vec<u8>
) where
    F: FnMut(&str) -> Option<usize>, 

Expands all instances of $name in replacement to the corresponding capture group name, and writes them to the dst buffer given.