Struct regex::bytes::SetMatches

source ·
pub struct SetMatches(/* private fields */);
Expand description

A set of matches returned by a regex set.

Values of this type are constructed by RegexSet::matches.

Implementations§

source§

impl SetMatches

source

pub fn matched_any(&self) -> bool

Whether this set contains any matches.

§Example
use regex::bytes::RegexSet;

let set = RegexSet::new(&[
    r"[a-z]+@[a-z]+\.(com|org|net)",
    r"[a-z]+\.(com|org|net)",
]).unwrap();
let matches = set.matches(b"foo@example.com");
assert!(matches.matched_any());
source

pub fn matched(&self, index: usize) -> bool

Whether the regex at the given index matched.

The index for a regex is determined by its insertion order upon the initial construction of a RegexSet, starting at 0.

§Panics

If index is greater than or equal to the number of regexes in the original set that produced these matches. Equivalently, when index is greater than or equal to SetMatches::len.

§Example
use regex::bytes::RegexSet;

let set = RegexSet::new([
    r"[a-z]+@[a-z]+\.(com|org|net)",
    r"[a-z]+\.(com|org|net)",
]).unwrap();
let matches = set.matches(b"example.com");
assert!(!matches.matched(0));
assert!(matches.matched(1));
source

pub fn len(&self) -> usize

The total number of regexes in the set that created these matches.

WARNING: This always returns the same value as RegexSet::len. In particular, it does not return the number of elements yielded by SetMatches::iter. The only way to determine the total number of matched regexes is to iterate over them.

§Example

Notice that this method returns the total number of regexes in the original set, and not the total number of regexes that matched.

use regex::bytes::RegexSet;

let set = RegexSet::new([
    r"[a-z]+@[a-z]+\.(com|org|net)",
    r"[a-z]+\.(com|org|net)",
]).unwrap();
let matches = set.matches(b"example.com");
// Total number of patterns that matched.
assert_eq!(1, matches.iter().count());
// Total number of patterns in the set.
assert_eq!(2, matches.len());
source

pub fn iter(&self) -> SetMatchesIter<'_>

Returns an iterator over the indices of the regexes that matched.

This will always produces matches in ascending order, where the index yielded corresponds to the index of the regex that matched with respect to its position when initially building the set.

§Example
use regex::bytes::RegexSet;

let set = RegexSet::new([
    r"[0-9]",
    r"[a-z]",
    r"[A-Z]",
    r"\p{Greek}",
]).unwrap();
let hay = "βa1".as_bytes();
let matches: Vec<_> = set.matches(hay).iter().collect();
assert_eq!(matches, vec![0, 1, 3]);

Note that SetMatches also implemnets the IntoIterator trait, so this method is not always needed. For example:

use regex::bytes::RegexSet;

let set = RegexSet::new([
    r"[0-9]",
    r"[a-z]",
    r"[A-Z]",
    r"\p{Greek}",
]).unwrap();
let hay = "βa1".as_bytes();
let mut matches = vec![];
for index in set.matches(hay) {
    matches.push(index);
}
assert_eq!(matches, vec![0, 1, 3]);

Trait Implementations§

source§

impl Clone for SetMatches

source§

fn clone(&self) -> SetMatches

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for SetMatches

source§

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

Formats the value using the given formatter. Read more
source§

impl<'a> IntoIterator for &'a SetMatches

§

type IntoIter = SetMatchesIter<'a>

Which kind of iterator are we turning this into?
§

type Item = usize

The type of the elements being iterated over.
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

impl IntoIterator for SetMatches

§

type IntoIter = SetMatchesIntoIter

Which kind of iterator are we turning this into?
§

type Item = usize

The type of the elements being iterated over.
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.