Struct regex_test::Captures

pub struct Captures { /* private fields */ }

Captures represents a single group of captured matches from a regex search.

There is always at least 1 group, and the first group is always present and corresponds to the overall match.

Implementations

impl Captures

pub fn new<I: IntoIterator<Item = Option<Span>>>( id: usize, it: I ) -> Result<Captures>

Create a new set of captures for a single match of a regex.

If available, iterator should provide items for every capturing group in the regex, including the 0th capturing group corresponding to the entire match. At minimum, the 0th capturing group should be provided.

If a capturing group did not participate in the match, then a None value should be used. (The 0th capturing group should never be None.)

If the iterator yields no elements or the first group is None, then this returns an error.

The id should be the ID of the pattern that matched. This is always 0 for single-pattern regexes. Otherwise, the ID of a pattern starts at 0 and is incremented by 1 for each subsequent pattern.

Note that there are possibly more convenient and infallible From impls for converting a Match or a Span into a Captures.

pub fn id(&self) -> usize

Returns the ID of the pattern that matched.

For any single pattern regexes, this should always be zero.

pub fn groups(&self) -> &[Option<Span>]

Returns a slice of the underlying spans, each group corresponding to the (possibly) matched span. The first group in the slice returned is guaranteed to correspond to the overall match span and is thus non-None. All other groups may be None. Similarly, the slice is guaranteed to have length at least 1.

pub fn len(&self) -> usize

Returns the number of groups (including the first) in these captures.

The length returned is guaranteed to be greater than zero.

pub fn to_match(&self) -> Match

Returns the overall match, including the pattern ID, for this group of captures.

pub fn to_span(&self) -> Span

Returns the overall match span for this group of captures.

Trait Implementations

impl Clone for Captures

fn clone(&self) -> Captures

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Captures

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Captures

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Match> for Captures

Converts a plain Match to a Captures value, where the match corresponds to the first and only group in Captures.

fn from(m: Match) -> Captures

Converts to this type from the input type.

impl From<Span> for Captures

Converts a plain Span to a Captures value, where the span corresponds to the first and only group in Captures. Since a Span does not contain a pattern ID, the pattern ID used in this conversion is always 0.

fn from(sp: Span) -> Captures

Converts to this type from the input type.

impl PartialEq<Captures> for Captures

fn eq(&self, other: &Captures) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Captures

impl StructuralEq for Captures

impl StructuralPartialEq for Captures