CINXE.COM

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta name="viewport" content="width=device-width, height=device-height, initial-scale=1, user-scalable=no"> <meta name="description" content="API docs for the Match class from the dart:core library, for the Dart programming language."> <title>Match class - dart:core library - Dart API</title> <link rel="canonical" href="https://api.dart.dev/dart-core/Match-class.html"> <link rel="preconnect" href="https://fonts.gstatic.com"> <link href="https://fonts.googleapis.com/css2?family=Roboto+Mono:ital,wght@0,300;0,400;0,500;0,700;1,400&display=swap" rel="stylesheet"> <link href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,GRAD@24,400,0,0" rel="stylesheet"> <link rel="stylesheet" href="../static-assets/github.css?v1"> <link rel="stylesheet" href="../static-assets/styles.css?v1"> <link rel="icon" href="../static-assets/favicon.png?v1">  <script async src="https://www.googletagmanager.com/gtag/js?id=G-VVQ8908SJ5"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'G-VVQ8908SJ5'); </script> <link rel="preconnect" href="https://fonts.googleapis.com"> <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin> <link rel="preload" href="https://fonts.googleapis.com/css2?family=Google+Sans+Text:wght@400&family=Google+Sans:wght@500&display=swap" as="style"> <link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Google+Sans+Text:wght@400&family=Google+Sans:wght@500&display=swap"> <link rel="stylesheet" href="https://www.gstatic.com/glue/cookienotificationbar/cookienotificationbar.min.css"> </head> <body data-base-href="../" data-using-base-href="false" class="light-theme"> <div id="overlay-under-drawer"></div> <header id="title"> <span id="sidenav-left-toggle" class="material-symbols-outlined" role="button" tabindex="0">menu</span> <ol class="breadcrumbs gt-separated dark hidden-xs"> <li><a href="../index.html">Dart</a></li> <li><a href="../dart-core/dart-core-library.html">dart:core</a></li> <li class="self-crumb">Match class</li> </ol> <div class="self-name">Match</div> <form class="search navbar-right" role="search"> <input type="text" id="search-box" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search..."> </form> <div class="toggle" id="theme-button" title="Toggle brightness"> <label for="theme"> <input type="checkbox" id="theme" value="light-theme"> <span id="dark-theme-button" class="material-symbols-outlined"> dark_mode </span> <span id="light-theme-button" class="material-symbols-outlined"> light_mode </span> </label> </div> </header> <main> <div id="dartdoc-main-content" class="main-content" data-above-sidebar="dart-core/dart-core-library-sidebar.html" data-below-sidebar="dart-core/Match-class-sidebar.html"> <div> <div id="external-links" class="btn-group"><a title="View source code" class="source-link" href="https://github.com/dart-lang/sdk/blob/88c9758ef131d430d8ce595c6bfb4c90574d3ddd/sdk/lib/core/pattern.dart#L85"><span class="material-symbols-outlined">description</span></a></div> <h1><span class="kind-class">Match</span> class <a href="https://dart.dev/language/class-modifiers#abstract" class="feature feature-abstract" title="This type can not be directly constructed.">abstract</a> <a href="https://dart.dev/language/class-modifiers#interface" class="feature feature-interface" title="This class can only be implemented (not extended or mixed in).">interface</a> </h1></div> <section class="desc markdown"> <p>A result from searching within a string.</p> <p>A <code>Match</code> or an <a href="../dart-core/Iterable-class.html">Iterable</a> of <code>Match</code> objects is returned from the <a href="../dart-core/Pattern-class.html">Pattern</a> matching methods (<a href="../dart-core/Pattern/allMatches.html">Pattern.allMatches</a> and <a href="../dart-core/Pattern/matchAsPrefix.html">Pattern.matchAsPrefix</a>).</p> <p>The following example finds all matches of a <a href="../dart-core/RegExp-class.html">RegExp</a> in a <a href="../dart-core/String-class.html">String</a> and iterates through the returned iterable of <code>Match</code> objects.</p> <pre class="language-dart"><code class="language-dart">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); } </code></pre> <p>The output of the example is:</p> <pre class="language-dart"><code>Parse my string </code></pre> <p>Some patterns, regular expressions in particular, may record substrings that were part of the matching. These are called <em>groups</em> in the <code>Match</code> object. Some patterns may never have any groups, and their matches always have zero <a href="../dart-core/Match/groupCount.html">groupCount</a>.</p> </section> <section> <dl class="dl-horizontal"> <dt>Implementers</dt> <dd><ul class="comma-separated clazz-relationships"> <li><a href="../dart-core/RegExpMatch-class.html">RegExpMatch</a></li> </ul></dd> </dl> </section> <section class="summary offset-anchor" id="instance-properties"> <h2>Properties</h2> <dl class="properties"> <dt id="end" class="property"> <span class="name"><a href="../dart-core/Match/end.html">end</a></span> <span class="signature">→ <a href="../dart-core/int-class.html">int</a></span> </dt> <dd> The index in the string after the last character of the match. <div class="features"><span class="feature">no setter</span></div> </dd> <dt id="groupCount" class="property"> <span class="name"><a href="../dart-core/Match/groupCount.html">groupCount</a></span> <span class="signature">→ <a href="../dart-core/int-class.html">int</a></span> </dt> <dd> Returns the number of captured groups in the match. <div class="features"><span class="feature">no setter</span></div> </dd> <dt id="hashCode" class="property inherited"> <span class="name"><a href="../dart-core/Object/hashCode.html">hashCode</a></span> <span class="signature">→ <a href="../dart-core/int-class.html">int</a></span> </dt> <dd class="inherited"> The hash code for this object. <div class="features"><span class="feature">no setter</span><span class="feature">inherited</span></div> </dd> <dt id="input" class="property"> <span class="name"><a href="../dart-core/Match/input.html">input</a></span> <span class="signature">→ <a href="../dart-core/String-class.html">String</a></span> </dt> <dd> The string on which this match was computed. <div class="features"><span class="feature">no setter</span></div> </dd> <dt id="pattern" class="property"> <span class="name"><a href="../dart-core/Match/pattern.html">pattern</a></span> <span class="signature">→ <a href="../dart-core/Pattern-class.html">Pattern</a></span> </dt> <dd> The pattern used to search in <a href="../dart-core/Match/input.html">input</a>. <div class="features"><span class="feature">no setter</span></div> </dd> <dt id="runtimeType" class="property inherited"> <span class="name"><a href="../dart-core/Object/runtimeType.html">runtimeType</a></span> <span class="signature">→ <a href="../dart-core/Type-class.html">Type</a></span> </dt> <dd class="inherited"> A representation of the runtime type of the object. <div class="features"><span class="feature">no setter</span><span class="feature">inherited</span></div> </dd> <dt id="start" class="property"> <span class="name"><a href="../dart-core/Match/start.html">start</a></span> <span class="signature">→ <a href="../dart-core/int-class.html">int</a></span> </dt> <dd> The index in the string where the match starts. <div class="features"><span class="feature">no setter</span></div> </dd> </dl> </section> <section class="summary offset-anchor" id="instance-methods"> <h2>Methods</h2> <dl class="callables"> <dt id="group" class="callable"> <span class="name"><a href="../dart-core/Match/group.html">group</a></span><span class="signature">(<wbr><span class="parameter" id="group-param-group"><span class="type-annotation"><a href="../dart-core/int-class.html">int</a></span> <span class="parameter-name">group</span></span>) <span class="returntype parameter">→ <a href="../dart-core/String-class.html">String</a>?</span> </span> </dt> <dd> The string matched by the given <a href="../dart-core/Match/group.html">group</a>. </dd> <dt id="groups" class="callable"> <span class="name"><a href="../dart-core/Match/groups.html">groups</a></span><span class="signature">(<wbr><span class="parameter" id="groups-param-groupIndices"><span class="type-annotation"><a href="../dart-core/List-class.html">List</a><span class="signature"><<wbr><span class="type-parameter"><a href="../dart-core/int-class.html">int</a></span>></span></span> <span class="parameter-name">groupIndices</span></span>) <span class="returntype parameter">→ <a href="../dart-core/List-class.html">List</a><span class="signature"><<wbr><span class="type-parameter"><a href="../dart-core/String-class.html">String</a>?</span>></span></span> </span> </dt> <dd> A list of the groups with the given indices. </dd> <dt id="noSuchMethod" class="callable inherited"> <span class="name"><a href="../dart-core/Object/noSuchMethod.html">noSuchMethod</a></span><span class="signature">(<wbr><span class="parameter" id="noSuchMethod-param-invocation"><span class="type-annotation"><a href="../dart-core/Invocation-class.html">Invocation</a></span> <span class="parameter-name">invocation</span></span>) <span class="returntype parameter">→ dynamic</span> </span> </dt> <dd class="inherited"> Invoked when a nonexistent method or property is accessed. <div class="features"><span class="feature">inherited</span></div> </dd> <dt id="toString" class="callable inherited"> <span class="name"><a href="../dart-core/Object/toString.html">toString</a></span><span class="signature">(<wbr>) <span class="returntype parameter">→ <a href="../dart-core/String-class.html">String</a></span> </span> </dt> <dd class="inherited"> A string representation of this object. <div class="features"><span class="feature">inherited</span></div> </dd> </dl> </section> <section class="summary offset-anchor" id="operators"> <h2>Operators</h2> <dl class="callables"> <dt id="operator ==" class="callable inherited"> <span class="name"><a href="../dart-core/Object/operator_equals.html">operator ==</a></span><span class="signature">(<wbr><span class="parameter" id="==-param-other"><span class="type-annotation"><a href="../dart-core/Object-class.html">Object</a></span> <span class="parameter-name">other</span></span>) <span class="returntype parameter">→ <a href="../dart-core/bool-class.html">bool</a></span> </span> </dt> <dd class="inherited"> The equality operator. <div class="features"><span class="feature">inherited</span></div> </dd> <dt id="operator []" class="callable"> <span class="name"><a href="../dart-core/Match/operator_get.html">operator []</a></span><span class="signature">(<wbr><span class="parameter" id="[]-param-group"><span class="type-annotation"><a href="../dart-core/int-class.html">int</a></span> <span class="parameter-name">group</span></span>) <span class="returntype parameter">→ <a href="../dart-core/String-class.html">String</a>?</span> </span> </dt> <dd> The string matched by the given <code>group</code>. </dd> </dl> </section> </div>  <div id="dartdoc-sidebar-left" class="sidebar sidebar-offcanvas-left">  <header id="header-search-sidebar" class="hidden-l"> <form class="search-sidebar" role="search"> <input type="text" id="search-sidebar" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search..."> </form> </header> <ol class="breadcrumbs gt-separated dark hidden-l" id="sidebar-nav"> <li><a href="../index.html">Dart</a></li> <li><a href="../dart-core/dart-core-library.html">dart:core</a></li> <li class="self-crumb">Match class</li> </ol> <h5>dart:core library</h5> <div id="dartdoc-sidebar-left-content"></div> </div> <div id="dartdoc-sidebar-right" class="sidebar sidebar-offcanvas-right"> </div> </main> <footer> <span class="no-break"> Dart 3.5.4 </span> <span class="glue-footer"> <span class="no-break"> | <a href="https://dart.dev/terms" title="Terms of use">Terms</a> </span> <span class="no-break"> | <a href="https://policies.google.com/privacy" target="_blank" rel="noopener" title="Privacy policy" class="no-automatic-external">Privacy</a> </span> <span class="no-break"> | <a href="https://dart.dev/security" title="Security philosophy and practices">Security</a> </span> <div class="copyright" style="font-size: 0.9em; color: darkgrey; margin-top: 0.5em;"> Except as otherwise noted, this site is licensed under a <a style="color: darkgrey;" href="https://creativecommons.org/licenses/by/4.0/"> Creative Commons Attribution 4.0 International License</a> and code samples are licensed under the <a style="color: darkgrey;" href="https://opensource.org/licenses/BSD-3-Clause" class="no-automatic-external"> 3-Clause BSD License</a> </div> </span> </footer> <script src="../static-assets/highlight.pack.js?v1"></script> <script src="../static-assets/docs.dart.js"></script> <button aria-hidden="true" class="glue-footer__link glue-cookie-notification-bar-control"> Cookies management controls </button> <script src="https://www.gstatic.com/glue/cookienotificationbar/cookienotificationbar.min.js" data-glue-cookie-notification-bar-category="2B"> </script> </body> </html>