Struct regex_automata::MultiMatch

pub struct MultiMatch { /* private fields */ }

A representation of a multi match reported by a regex engine.

A multi match has two essential pieces of information: the identifier of the pattern that matched, along with the start and end offsets of the match in the haystack.

The pattern is identified by an ID, which corresponds to its position (starting from 0) relative to other patterns used to construct the corresponding regex engine. If only a single pattern is provided, then all multi matches are guaranteed to have a pattern ID of 0.

Every multi match guarantees that start <= end.

Implementations

impl MultiMatch

pub fn new(pattern: PatternID, start: usize, end: usize) -> MultiMatch

Create a new match from a pattern ID and a byte offset span.

Panics

This panics if end < start.

pub fn must(pattern: usize, start: usize, end: usize) -> MultiMatch

Create a new match from a pattern ID and a byte offset span.

This is like MultiMatch::new, but accepts a usize instead of a PatternID. This panics if the given usize is not representable as a PatternID.

Panics

This panics if end < start or if pattern > PatternID::MAX.

pub fn pattern(&self) -> PatternID

Returns the ID of the pattern that matched.

The ID of a pattern is derived from the position in which it was originally inserted into the corresponding regex engine. The first pattern has identifier 0, and each subsequent pattern is 1, 2 and so on.

pub fn start(&self) -> usize

The starting position of the match.

pub fn end(&self) -> usize

The ending position of the match.

pub fn range(&self) -> Range<usize>

Returns the match location as a range.

pub fn is_empty(&self) -> bool

Returns true if and only if this match is empty. That is, when start() == end().

An empty match can only be returned when the empty string was among the patterns used to build the Aho-Corasick automaton.

Trait Implementations

impl Clone for MultiMatch

fn clone(&self) -> MultiMatch

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MultiMatch

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

Formats the value using the given formatter.

impl Hash for MultiMatch

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<MultiMatch> for MultiMatch

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

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

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

This method tests for !=.

impl Eq for MultiMatch

impl StructuralEq for MultiMatch

impl StructuralPartialEq for MultiMatch