2024-07-26 09:44:36 +00:00
<!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 = "Repeats the embedded parser, lazily returning the results" > < title > iterator in winnow::combinator - Rust< / title > < script > if ( window . location . protocol !== "file:" ) document . head . insertAdjacentHTML ( "beforeend" , "SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2" . split ( "," ) . map ( f => ` <link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/ ${ f } "> ` ) . join ( "" ) ) < / script > < link rel = "stylesheet" href = "../../static.files/normalize-76eba96aa4d2e634.css" > < link rel = "stylesheet" href = "../../static.files/rustdoc-dd39b87e5fcfba68.css" > < meta name = "rustdoc-vars" data-root-path = "../../" data-static-root-path = "../../static.files/" data-current-crate = "winnow" data-themes = "" data-resource-suffix = "" data-rustdoc-version = "1.80.0 (051478957 2024-07-21)" data-channel = "1.80.0" data-search-js = "search-d52510db62a78183.js" data-settings-js = "settings-4313503d2e1961c2.js" > < script src = "../../static.files/storage-118b08c4c78b968e.js" > < / script > < script defer src = "sidebar-items.js" > < / script > < script defer src = "../../static.files/main-20a3ad099b048cf2.js" > < / script > < noscript > < link rel = "stylesheet" href = "../../static.files/noscript-df360f571f6edeae.css" > < / noscript > < 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" title = "show sidebar" > < / button > < / nav > < nav class = "sidebar" > < div class = "sidebar-crate" > < h2 > < a href = "../../winnow/index.html" > winnow< / a > < span class = "version" > 0.6.16< / span > < / h2 > < / div > < div class = "sidebar-elems" > < h2 > < a href = "index.html" > In winnow::combinator< / a > < / h2 > < / div > < / nav > < div class = "sidebar-resizer" > < / div > < main > < div class = "width-limiter" > < rustdoc-search > < / rustdoc-search > < section id = "main-content" class = "content" > < div class = "main-heading" > < h1 > Function < a href = "../index.html" > winnow< / 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" > Copy item path< / button > < / h1 > < span class = "out-of-band" > < a class = "src" href = "../../src/winnow/combinator/core.rs.html#411-426" > 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, ParseNext> (
2024-03-11 08:39:13 +00:00
input: Input,
2024-07-26 09:42:18 +00:00
parser: ParseNext,
2024-03-11 08:39:13 +00:00
) -> < a class = "struct" href = "struct.ParserIterator.html" title = "struct winnow::combinator::ParserIterator" > ParserIterator< / a > < ParseNext, Input, Output, Error> < a href = "#" class = "tooltip" data-notable-ty = "ParserIterator<ParseNext, Input, Output, Error>" > ⓘ< / a > < div class = "where" > where
ParseNext: < a class = "trait" href = "../trait.Parser.html" title = "trait winnow::Parser" > Parser< / a > < Input, Output, Error> ,
Input: < a class = "trait" href = "../stream/trait.Stream.html" title = "trait winnow::stream::Stream" > Stream< / a > ,
Error: < a class = "trait" href = "../error/trait.ParserError.html" title = "trait winnow::error::ParserError" > ParserError< / a > < Input> ,< / div > < / code > < / pre > < details class = "toggle top-doc" open > < summary class = "hideme" > < span > Expand description< / span > < / summary > < div class = "docblock" > < p > Repeats the embedded parser, lazily returning the results< / p >
< p > Call the iterator’ < a href = "struct.ParserIterator.html#method.finish" title = "method winnow::combinator::ParserIterator::finish" > < code > ParserIterator::finish< / code > < / a > method to get the remaining input if successful,
or the error value if we encountered an error.< / p >
< p > On < a href = "../error/enum.ErrMode.html#variant.Backtrack" title = "variant winnow::error::ErrMode::Backtrack" > < code > ErrMode::Backtrack< / code > < / a > , iteration will stop. To instead chain an error up, see < a href = "fn.cut_err.html" title = "fn winnow::combinator::cut_err" > < code > cut_err< / code > < / a > .< / p >
2024-03-27 11:12:16 +00:00
< h2 id = "example" > < a class = "doc-anchor" href = "#example" > §< / a > Example< / h2 >
2024-03-11 08:39:13 +00:00
< div class = "example-wrap" > < pre class = "rust rust-example-rendered" > < code > < span class = "kw" > use < / span > winnow::{combinator::iterator, IResult, ascii::alpha1, combinator::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, < 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 >
2024-07-26 09:42:18 +00:00
< / div > < / details > < script type = "text/json" id = "notable-traits-data" > { "ParserIterator<ParseNext, Input, Output, Error>" : "<h3>Notable traits for <code>&'a mut <a class=\"struct\" href=\"struct.ParserIterator.html\" title=\"struct winnow::combinator::ParserIterator\">ParserIterator</a><F, I, O, E></code></h3><pre><code><div class=\"where\">impl<'a, F, I, O, E> <a class=\"trait\" href=\"https://doc.rust-lang.org/1.80.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 winnow::combinator::ParserIterator\">ParserIterator</a><F, I, O, E><div class=\"where\">where\n F: <a class=\"trait\" href=\"../trait.Parser.html\" title=\"trait winnow::Parser\">Parser</a><I, O, E>,\n I: <a class=\"trait\" href=\"../stream/trait.Stream.html\" title=\"trait winnow::stream::Stream\">Stream</a>,</div></div><div class=\"where\"> type <a href=\"https://doc.rust-lang.org/1.80.0/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item\" class=\"associatedtype\">Item</a> = O;</div>" } < / script > < / section > < / div > < / main > < / body > < / html >
