edlang/regex_automata/util/iter/index.html
2024-02-13 06:38:44 +00:00

9 lines
7.1 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../../static.files/rustdoc-ac92e1bbe349e143.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.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-feafe1bb7466e4bd.css"></noscript><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../../static.files/favicon-2c020d218678b618.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]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../regex_automata/index.html">regex_automata</a><span class="version">0.4.5</span></h2></div><h2 class="location"><a href="#">Module iter</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li></ul></section><h2><a href="../index.html">In regex_automata::util</a></h2></div></nav><div class="sidebar-resizer"></div>
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../../regex_automata/all.html" title="show sidebar"></a></div><input class="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"><div id="help-button" tabindex="-1"><a href="../../../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Module <a href="../../index.html">regex_automata</a>::<wbr><a href="../index.html">util</a>::<wbr><a class="mod" href="#">iter</a><button id="copy-path" title="Copy item path to clipboard"><img src="../../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../../../src/regex_automata/util/iter.rs.html#1-1027">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></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"><a href="#structs">Structs</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.CapturesIter.html" title="struct regex_automata::util::iter::CapturesIter">CapturesIter</a></div><div class="desc docblock-short">An iterator over all non-overlapping captures for an infallible search.</div></li><li><div class="item-name"><a class="struct" href="struct.HalfMatchesIter.html" title="struct regex_automata::util::iter::HalfMatchesIter">HalfMatchesIter</a></div><div class="desc docblock-short">An iterator over all non-overlapping half matches for an infallible search.</div></li><li><div class="item-name"><a class="struct" href="struct.MatchesIter.html" title="struct regex_automata::util::iter::MatchesIter">MatchesIter</a></div><div class="desc docblock-short">An iterator over all non-overlapping matches for an infallible search.</div></li><li><div class="item-name"><a class="struct" href="struct.Searcher.html" title="struct regex_automata::util::iter::Searcher">Searcher</a></div><div class="desc docblock-short">A searcher for creating iterators and performing lower level iteration.</div></li><li><div class="item-name"><a class="struct" href="struct.TryCapturesIter.html" title="struct regex_automata::util::iter::TryCapturesIter">TryCapturesIter</a></div><div class="desc docblock-short">An iterator over all non-overlapping captures for a fallible search.</div></li><li><div class="item-name"><a class="struct" href="struct.TryHalfMatchesIter.html" title="struct regex_automata::util::iter::TryHalfMatchesIter">TryHalfMatchesIter</a></div><div class="desc docblock-short">An iterator over all non-overlapping half matches for a fallible search.</div></li><li><div class="item-name"><a class="struct" href="struct.TryMatchesIter.html" title="struct regex_automata::util::iter::TryMatchesIter">TryMatchesIter</a></div><div class="desc docblock-short">An iterator over all non-overlapping matches for a fallible search.</div></li></ul></section></div></main></body></html>