|
|
<!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="Creates an iterator from input data and a parser."><title>iterator in nom::combinator - 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="nom" 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 fn"><!--[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">☰</button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../nom/index.html">nom</a><span class="version">7.1.3</span></h2></div><div class="sidebar-elems"><h2><a href="index.html">In nom::combinator</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="../../nom/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>Function <a href="../index.html">nom</a>::<wbr><a href="index.html">combinator</a>::<wbr><a class="fn" href="#">iterator</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/nom/combinator/mod.rs.html#700-710">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub fn iterator<Input, Output, Error, F>(
|
|
|
input: Input,
|
|
|
f: F
|
|
|
) -> <a class="struct" href="struct.ParserIterator.html" title="struct nom::combinator::ParserIterator">ParserIterator</a><Input, Error, F> <a href="#" class="tooltip" data-notable-ty="ParserIterator<Input, Error, F>">ⓘ</a><div class="where">where
|
|
|
F: <a class="trait" href="../trait.Parser.html" title="trait nom::Parser">Parser</a><Input, Output, Error>,
|
|
|
Error: <a class="trait" href="../error/trait.ParseError.html" title="trait nom::error::ParseError">ParseError</a><Input>,</div></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Creates an iterator from input data and a parser.</p>
|
|
|
<p>Call the iterator’s <a href="struct.ParserIterator.html#method.finish" title="method nom::combinator::ParserIterator::finish">ParserIterator::finish</a> method to get the remaining input if successful,
|
|
|
or the error value if we encountered an error.</p>
|
|
|
<p>On <a href="../enum.Err.html#variant.Error" title="variant nom::Err::Error"><code>Err::Error</code></a>, iteration will stop. To instead chain an error up, see <a href="fn.cut.html" title="fn nom::combinator::cut"><code>cut</code></a>.</p>
|
|
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>nom::{combinator::iterator, IResult, bytes::complete::tag, character::complete::alpha1, sequence::terminated};
|
|
|
<span class="kw">use </span>std::collections::HashMap;
|
|
|
|
|
|
<span class="kw">let </span>data = <span class="string">"abc|defg|hijkl|mnopqr|123"</span>;
|
|
|
<span class="kw">let </span><span class="kw-2">mut </span>it = iterator(data, terminated(alpha1, tag(<span class="string">"|"</span>)));
|
|
|
|
|
|
<span class="kw">let </span>parsed = it.map(|v| (v, v.len())).collect::<HashMap<<span class="kw">_</span>,<span class="kw">_</span>>>();
|
|
|
<span class="kw">let </span>res: IResult<<span class="kw">_</span>,<span class="kw">_</span>> = it.finish();
|
|
|
|
|
|
<span class="macro">assert_eq!</span>(parsed, [(<span class="string">"abc"</span>, <span class="number">3usize</span>), (<span class="string">"defg"</span>, <span class="number">4</span>), (<span class="string">"hijkl"</span>, <span class="number">5</span>), (<span class="string">"mnopqr"</span>, <span class="number">6</span>)].iter().cloned().collect());
|
|
|
<span class="macro">assert_eq!</span>(res, <span class="prelude-val">Ok</span>((<span class="string">"123"</span>, ())));</code></pre></div>
|
|
|
</div></details><script type="text/json" id="notable-traits-data">{"ParserIterator<Input, Error, F>":"<h3>Notable traits for <code>&'a mut <a class=\"struct\" href=\"struct.ParserIterator.html\" title=\"struct nom::combinator::ParserIterator\">ParserIterator</a><Input, Error, F></code></h3><pre><code><div class=\"where\">impl<'a, Input, Output, Error, F> <a class=\"trait\" href=\"https://doc.rust-lang.org/1.76.0/core/iter/traits/iterator/trait.Iterator.html\" title=\"trait core::iter::traits::iterator::Iterator\">Iterator</a> for &'a mut <a class=\"struct\" href=\"struct.ParserIterator.html\" title=\"struct nom::combinator::ParserIterator\">ParserIterator</a><Input, Error, F><div class=\"where\">where\n F: <a class=\"trait\" href=\"https://doc.rust-lang.org/1.76.0/core/ops/function/trait.FnMut.html\" title=\"trait core::ops::function::FnMut\">FnMut</a>(Input) -> <a class=\"type\" href=\"../type.IResult.html\" title=\"type nom::IResult\">IResult</a><Input, Output, Error>,\n Input: <a class=\"trait\" href=\"https://doc.rust-lang.org/1.76.0/core/clone/trait.Clone.html\" title=\"trait core::clone::Clone\">Clone</a>,</div></div><div class=\"where\"> type <a href=\"https://doc.rust-lang.org/1.76.0/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item\" class=\"associatedtype\">Item</a> = Output;</div>"}</script></section></div></main></body></html> |