Struct regress::Match

pub struct Match {
    pub range: Range,
    pub captures: Vec<Option<Range>>,
    /* private fields */
}

A Match represents a portion of a string which was found to match a Regex.

Fields

range: Range

The total range of the match. Note this may be empty, if the regex matched an empty string.

captures: Vec<Option<Range>>

The list of captures. This has length equal to the number of capturing groups in the regex. For each capture, if the value is None, that group did not match (for example, it was in a not-taken branch of an alternation). If the value is Some, the group did match with the enclosed range.

Implementations

impl Match

pub fn group(&self, idx: usize) -> Option<Range>

Access a group by index, using the convention of Python’s group() function. Index 0 is the total match, index 1 is the first capture group.

pub fn named_group(&self, name: &str) -> Option<Range>

Access a named group by name.

pub fn named_groups(&self) -> NamedGroups<'_>

Return an iterator over the named groups of a Match.

pub fn range(&self) -> Range

Returns the range over the starting and ending byte offsets of the match in the haystack.

This is a convenience function to work around the fact that Range does not support Copy.

pub fn start(&self) -> usize

Returns the starting byte offset of the match in the haystack.

pub fn end(&self) -> usize

Returns the ending byte offset of the match in the haystack.

pub fn groups(&self) -> Groups<'_>

Return an iterator over a Match. The first returned value is the total match, and subsequent values represent the capture groups.

Trait Implementations

impl Clone for Match

fn clone(&self) -> Match

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Match

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

Formats the value using the given formatter.