dart:core

Match class

A result from searching within a string.

A Match or an Iterable of Match objects is returned from the Pattern matching methods (Pattern.allMatches and Pattern.matchAsPrefix).

The following example finds all matches of a RegExp in a String and iterates through the returned iterable of Match objects.

final regExp = RegExp(r'(\w+)');
const string = 'Parse my string';
final matches = regExp.allMatches(string);
for (final m in matches) {
  String match = m[0]!;
  print(match);
}

The output of the example is:

Parse
my
string

Some patterns, regular expressions in particular, may record substrings that were part of the matching. These are called groups in the Match object. Some patterns may never have any groups, and their matches always have zero groupCount.

Implementers

• RegExpMatch

Constructors

Match()

Properties

end → int

read-only

The index in the string after the last character of the match.

groupCount → int

read-only

Returns the number of captured groups in the match.

hashCode → int

read-only, inherited

The hash code for this object.

input → String

read-only

The string on which this match was computed.

pattern → Pattern

read-only

The pattern used to search in input.

runtimeType → Type

read-only, inherited

A representation of the runtime type of the object.

start → int

read-only

The index in the string where the match starts.

Methods

group(int group) → String?

The string matched by the given group.

groups(List<int> groupIndices) → List<String?>

A list of the groups with the given indices.

noSuchMethod(Invocation invocation) → dynamic

inherited

Invoked when a non-existent method or property is accessed.

toString() → String

inherited

A string representation of this object.

Operators

operator ==(Object other) → bool

inherited

The equality operator.

operator [](int group) → String?

The string matched by the given group.