dart:core

RegExp class

A regular expression pattern.

Regular expressions are Patterns, and can as such be used to match strings or parts of strings.

Dart regular expressions have the same syntax and semantics as JavaScript regular expressions. See ecma-international.org/ecma-262/9.0/#sec-regexp-regular-expression-objects for the specification of JavaScript regular expressions.

The firstMatch method is the main implementation method that applies a regular expression to a string and returns the first RegExpMatch. All other methods in RegExp can be build from that.

Use allMatches to look for all matches of a regular expression in a string.

The following example finds all matches of a regular expression in a string.

RegExp exp = RegExp(r"(\w+)");
String str = "Parse my string";
Iterable<RegExpMatch> matches = exp.allMatches(str);

Note the use of a raw string (a string prefixed with r) in the example above. Use a raw string to treat each character in a string as a literal character.

Implemented types

• Pattern

Constructors

RegExp(String source, {bool multiLine = false, bool caseSensitive = true, @Since("2.4") bool unicode = false, @Since("2.4") bool dotAll = false})

factory

Constructs a regular expression. [...]

Properties

hashCode → int

read-only, inherited

The hash code for this object. [...]

isCaseSensitive → bool

read-only

Whether this regular expression is case sensitive. [...]

isDotAll → bool

@Since("2.4"), read-only

Whether "." in this regular expression matches line terminators. [...]

isMultiLine → bool

read-only

Whether this regular expression matches multiple lines. [...]

isUnicode → bool

@Since("2.4"), read-only

Whether this regular expression is in Unicode mode. [...]

pattern → String

read-only

The source regular expression string used to create this RegExp.

runtimeType → Type

read-only, inherited

A representation of the runtime type of the object.

Methods

allMatches(String input, [int start = 0]) → Iterable<RegExpMatch>

override

Matches this pattern against the string repeatedly. [...]

firstMatch(String input) → RegExpMatch?

Finds the first match of the regular expression in the string input. [...]

hasMatch(String input) → bool

Whether the regular expression has a match in the string input.

matchAsPrefix(String string, [int start = 0]) → Match?

inherited

Matches this pattern against the start of string. [...]

noSuchMethod(Invocation invocation) → dynamic

inherited

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

stringMatch(String input) → String?

The substring of the first match of this regular expression in input.

toString() → String

inherited

A string representation of this object. [...]

Operators

operator ==(Object other) → bool

inherited

The equality operator. [...]

Static Methods

escape(String text) → String

Creates regular expression syntax that matches text. [...]