Struct stam::FindRegexMatch

pub struct FindRegexMatch<'t, 'r> { /* private fields */ }

This match structure is returned by the FindRegexIter iterator, which is in turn produced by [TextResource.find_text_regex()] and searches a text based on regular expressions. This structure represents a single regular-expression match of the iterator on the text.

Implementations

impl<'t, 'r> FindRegexMatch<'t, 'r>

pub fn multi(&self) -> bool

Does this match return multiple text selections? Multiple text selections are returned only when the expression contains multiple capture groups.

pub fn expression(&self) -> &'r Regex

Returns the regular expression that matched

pub fn expression_index(&self) -> usize

Returns the index of regular expression that matched

pub fn textselections(&self) -> &[WrappedItem<'t, TextSelection>]

pub fn resource(&self) -> &'t TextResource

pub fn capturegroups(&self) -> &[usize]

Records the number of the capture groups (1-indexed!) that match. This array has the same length as textselections and identifies precisely which textselection corresponds with which capture group.

pub fn as_str(&self) -> Option<&'t str>

Return the text of the match, this only works if the regular expression targets a single consecutive text, i.e. by not using multiple capture groups.

pub fn text(&self) -> Vec<&str>

This returns a vector of texts and is mainly useful in case multiple patterns were captured. Use Self::as_str() instead if you expect only a single text item.