17 lines
9.2 KiB
HTML
17 lines
9.2 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="Creates an iterator from input data and a parser."><meta name="keywords" content="rust, rustlang, rust-lang, iterator"><title>iterator in nom::combinator - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.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><a class="sidebar-logo" href="../../nom/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../nom/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2 class="location"><a href="index.html">In nom::combinator</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../nom/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">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" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/nom/combinator/mod.rs.html#700-710">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="docblock item-decl"><pre class="rust fn"><code>pub fn iterator<Input, Output, Error, F>(<br> input: Input,<br> f: F<br>) -> <a class="struct" href="struct.ParserIterator.html" title="struct nom::combinator::ParserIterator">ParserIterator</a><Input, Error, F><span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<span class="notable-traits-tooltiptext"><span class="docblock"><span class="notable">Notable traits for &'a mut <a class="struct" href="struct.ParserIterator.html" title="struct nom::combinator::ParserIterator">ParserIterator</a><Input, Error, F></span><code class="content"><span class="where fmt-newline">impl<'a, Input, Output, Error, F> <a class="trait" href="https://doc.rust-lang.org/1.64.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> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/1.64.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>,<br> Input: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>, </span></span><span class="where fmt-newline"> type <a href="https://doc.rust-lang.org/1.64.0/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item" class="associatedtype">Item</a> = Output;</span></code></span></span></span></span> <span class="where fmt-newline">where<br> F: <a class="trait" href="../trait.Parser.html" title="trait nom::Parser">Parser</a><Input, Output, Error>,<br> Error: <a class="trait" href="../error/trait.ParseError.html" title="trait nom::error::ParseError">ParseError</a><Input>, </span></code></pre></div><details class="rustdoc-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="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="Err::Error"><code>Err::Error</code></a>, iteration will stop. To instead chain an error up, see <a href="fn.cut.html" title="cut"><code>cut</code></a>.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">nom</span>::{<span class="ident">combinator::iterator</span>, <span class="ident">IResult</span>, <span class="ident">bytes::complete::tag</span>, <span class="ident">character::complete::alpha1</span>, <span class="ident">sequence::terminated</span>};
|
||
<span class="kw">use</span> <span class="ident">std::collections::HashMap</span>;
|
||
|
||
<span class="kw">let</span> <span class="ident">data</span> <span class="op">=</span> <span class="string">"abc|defg|hijkl|mnopqr|123"</span>;
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">it</span> <span class="op">=</span> <span class="ident">iterator</span>(<span class="ident">data</span>, <span class="ident">terminated</span>(<span class="ident">alpha1</span>, <span class="ident">tag</span>(<span class="string">"|"</span>)));
|
||
|
||
<span class="kw">let</span> <span class="ident">parsed</span> <span class="op">=</span> <span class="ident">it</span>.<span class="ident">map</span>(<span class="op">|</span><span class="ident">v</span><span class="op">|</span> (<span class="ident">v</span>, <span class="ident">v</span>.<span class="ident">len</span>())).<span class="ident">collect</span>::<span class="op"><</span><span class="ident">HashMap</span><span class="op"><</span><span class="kw">_</span>,<span class="kw">_</span><span class="op">></span><span class="op">></span>();
|
||
<span class="kw">let</span> <span class="ident">res</span>: <span class="ident">IResult</span><span class="op"><</span><span class="kw">_</span>,<span class="kw">_</span><span class="op">></span> <span class="op">=</span> <span class="ident">it</span>.<span class="ident">finish</span>();
|
||
|
||
<span class="macro">assert_eq!</span>(<span class="ident">parsed</span>, [(<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>)].<span class="ident">iter</span>().<span class="ident">cloned</span>().<span class="ident">collect</span>());
|
||
<span class="macro">assert_eq!</span>(<span class="ident">res</span>, <span class="prelude-val">Ok</span>((<span class="string">"123"</span>, ())));</code></pre></div>
|
||
</div></details></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="nom" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html> |