<main><divclass="width-limiter"><navclass="sub"><formclass="search-form"><span></span><divid="sidebar-button"tabindex="-1"><ahref="../../../regex_automata/all.html"title="show sidebar"></a></div><inputclass="search-input"name="search"aria-label="Run search in the documentation"autocomplete="off"spellcheck="false"placeholder="Click or press ‘S’ to search, ‘?’ for more options…"type="search"><divid="help-button"tabindex="-1"><ahref="../../../help.html"title="help">?</a></div><divid="settings-menu"tabindex="-1"><ahref="../../../settings.html"title="settings"><imgwidth="22"height="22"alt="Change settings"src="../../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><sectionid="main-content"class="content"><divclass="main-heading"><h1>Module <ahref="../../index.html">regex_automata</a>::<wbr><ahref="../index.html">util</a>::<wbr><aclass="mod"href="#">iter</a><buttonid="copy-path"title="Copy item path to clipboard"><imgsrc="../../../static.files/clipboard-7571035ce49a181d.svg"width="19"height="18"alt="Copy item path"></button></h1><spanclass="out-of-band"><aclass="src"href="../../../src/regex_automata/util/iter.rs.html#1-1027">source</a> · <buttonid="toggle-all-docs"title="collapse all docs">[<span>−</span>]</button></span></div><detailsclass="toggle top-doc"open><summaryclass="hideme"><span>Expand description</span></summary><divclass="docblock"><p>Generic helpers for iteration of matches from a regex engine in a haystack.</p>
<p>The principle type in this module is a <ahref="struct.Searcher.html"title="struct regex_automata::util::iter::Searcher"><code>Searcher</code></a>. A <code>Searcher</code> provides
its own lower level iterator-like API in addition to methods for constructing
types that implement <code>Iterator</code>. The documentation for <code>Searcher</code> explains a
bit more about why these different APIs exist.</p>
<p>Currently, this module supports iteration over any regex engine that works
with the <ahref="../../struct.HalfMatch.html"title="struct regex_automata::HalfMatch"><code>HalfMatch</code></a>, <ahref="../../struct.Match.html"title="struct regex_automata::Match"><code>Match</code></a> or <ahref="../captures/struct.Captures.html"title="struct regex_automata::util::captures::Captures"><code>Captures</code></a> types.</p>
</div></details><h2id="structs"class="section-header">Structs<ahref="#structs"class="anchor">§</a></h2><ulclass="item-table"><li><divclass="item-name"><aclass="struct"href="struct.CapturesIter.html"title="struct regex_automata::util::iter::CapturesIter">CapturesIter</a></div><divclass="desc docblock-short">An iterator over all non-overlapping captures for an infallible search.</div></li><li><divclass="item-name"><aclass="struct"href="struct.HalfMatchesIter.html"title="struct regex_automata::util::iter::HalfMatchesIter">HalfMatchesIter</a></div><divclass="desc docblock-short">An iterator over all non-overlapping half matches for an infallible search.</div></li><li><divclass="item-name"><aclass="struct"href="struct.MatchesIter.html"title="struct regex_automata::util::iter::MatchesIter">MatchesIter</a></div><divclass="desc docblock-short">An iterator over all non-overlapping matches for an infallible search.</div></li><li><divclass="item-name"><aclass="struct"href="struct.Searcher.html"title="struct regex_automata::util::iter::Searcher">Searcher</a></div><divclass="desc docblock-short">A searcher for creating iterators and performing lower level iteration.</div></li><li><divclass="item-name"><aclass="struct"href="struct.TryCapturesIter.html"title="struct regex_automata::util::iter::TryCapturesIter">TryCapturesIter</a></div><divclass="desc docblock-short">An iterator over all non-overlapping captures for a fallible search.</div></li><li><divclass="item-name"><aclass="struct"href="struct.TryHalfMatchesIter.html"title="struct regex_automata::util::iter::TryHalfMatchesIter">TryHalfMatchesIter</a></div><divclass="desc docblock-short">An iterator over all non-overlapping half matches for a fallible search.</div></li><li><divclass="item-name"><aclass="struct"href="struct.TryMatchesIter.html"title="struct regex_automata::util::iter::TryMatchesIter">TryMatchesIter</a></div><divclass="desc docblock-short">An iterator over all non-overlapping matches for a fallible search.</div></li></ul></section></div></main></body></html>
