8 lines
5.8 KiB
HTML
8 lines
5.8 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Generic helpers for iteration of matches from a regex engine in a haystack."><title>regex_automata::util::iter - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="regex_automata" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../../static.files/storage-e2aeef58.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../../static.files/favicon-044be391.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">Module iter</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../regex_automata/index.html">regex_<wbr>automata</a><span class="version">0.4.14</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module iter</a></h2><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="../index.html">In regex_<wbr>automata::<wbr>util</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../../index.html">regex_automata</a>::<wbr><a href="../index.html">util</a></div><h1>Module <span>iter</span> <button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../../src/regex_automata/util/iter.rs.html#1-1022">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="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 <a href="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 <a href="../../struct.HalfMatch.html" title="struct regex_automata::HalfMatch"><code>HalfMatch</code></a>, <a href="../../struct.Match.html" title="struct regex_automata::Match"><code>Match</code></a> or <a href="../captures/struct.Captures.html" title="struct regex_automata::util::captures::Captures"><code>Captures</code></a> types.</p>
|
|
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.CapturesIter.html" title="struct regex_automata::util::iter::CapturesIter">Captures<wbr>Iter</a></dt><dd>An iterator over all non-overlapping captures for an infallible search.</dd><dt><a class="struct" href="struct.HalfMatchesIter.html" title="struct regex_automata::util::iter::HalfMatchesIter">Half<wbr>Matches<wbr>Iter</a></dt><dd>An iterator over all non-overlapping half matches for an infallible search.</dd><dt><a class="struct" href="struct.MatchesIter.html" title="struct regex_automata::util::iter::MatchesIter">Matches<wbr>Iter</a></dt><dd>An iterator over all non-overlapping matches for an infallible search.</dd><dt><a class="struct" href="struct.Searcher.html" title="struct regex_automata::util::iter::Searcher">Searcher</a></dt><dd>A searcher for creating iterators and performing lower level iteration.</dd><dt><a class="struct" href="struct.TryCapturesIter.html" title="struct regex_automata::util::iter::TryCapturesIter">TryCaptures<wbr>Iter</a></dt><dd>An iterator over all non-overlapping captures for a fallible search.</dd><dt><a class="struct" href="struct.TryHalfMatchesIter.html" title="struct regex_automata::util::iter::TryHalfMatchesIter">TryHalf<wbr>Matches<wbr>Iter</a></dt><dd>An iterator over all non-overlapping half matches for a fallible search.</dd><dt><a class="struct" href="struct.TryMatchesIter.html" title="struct regex_automata::util::iter::TryMatchesIter">TryMatches<wbr>Iter</a></dt><dd>An iterator over all non-overlapping matches for a fallible search.</dd></dl></section></div></main></body></html> |