| <!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="This crate contains parser combinators, roughly based on the Haskell libraries parsec and attoparsec."><meta name="keywords" content="rust, rustlang, rust-lang, combine"><title>combine - 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" href="../normalize.css"><link rel="stylesheet" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../ayu.css" disabled><link rel="stylesheet" href="../dark.css" disabled><link rel="stylesheet" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer src="../crates.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 mod crate"><!--[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="../combine/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../combine/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Crate combine</a></h2><div class="sidebar-elems"><ul class="block"><li class="version">Version 4.6.6</li><li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#modules">Modules</a></li><li><a href="#macros">Macros</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li><li><a href="#types">Type Definitions</a></li></ul></section></div></nav><main><div class="width-limiter"><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"><a href="../help.html">?</a></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><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Crate <a class="mod" href="#">combine</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></h1><span class="out-of-band"><a class="srclink" href="../src/combine/lib.rs.html#1-1012">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>This crate contains parser combinators, roughly based on the Haskell libraries |
| <a href="http://hackage.haskell.org/package/parsec">parsec</a> and |
| <a href="https://hackage.haskell.org/package/attoparsec">attoparsec</a>.</p> |
| <p>A parser in this library can be described as a function which takes some input and if it |
| is successful, returns a value together with the remaining input. |
| A parser combinator is a function which takes one or more parsers and returns a new parser. |
| For instance the <a href="parser/repeat/fn.many.html"><code>many</code></a> parser can be used to convert a parser for single digits into one that |
| parses multiple digits. By modeling parsers in this way it becomes easy to compose complex |
| parsers in an almost declarative way.</p> |
| <h2 id="overview"><a href="#overview">Overview</a></h2> |
| <p><code>combine</code> limits itself to creating <a href="https://en.wikipedia.org/wiki/LL_parser">LL(1) parsers</a> |
| (it is possible to opt-in to LL(k) parsing using the <a href="parser/combinator/fn.attempt.html"><code>attempt</code></a> combinator) which makes the |
| parsers easy to reason about in both function and performance while sacrificing |
| some generality. In addition to you being able to reason better about the parsers you |
| construct <code>combine</code> the library also takes the knowledge of being an LL parser and uses it to |
| automatically construct good error messages.</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">extern crate </span>combine; |
| <span class="kw">use </span>combine::{Parser, EasyParser}; |
| <span class="kw">use </span>combine::stream::position; |
| <span class="kw">use </span>combine::parser::char::{digit, letter}; |
| <span class="kw">const </span>MSG: <span class="kw-2">&</span><span class="lifetime">'static </span>str = <span class="string">r#"Parse error at line: 1, column: 1 |
| Unexpected `|` |
| Expected digit or letter |
| "#</span>; |
| |
| <span class="kw">fn </span>main() { |
| <span class="comment">// Wrapping a `&str` with `State` provides automatic line and column tracking. If `State` |
| // was not used the positions would instead only be pointers into the `&str` |
| </span><span class="kw">if let </span><span class="prelude-val">Err</span>(err) = digit().or(letter()).easy_parse(position::Stream::new(<span class="string">"|"</span>)) { |
| <span class="macro">assert_eq!</span>(MSG, <span class="macro">format!</span>(<span class="string">"{}"</span>, err)); |
| } |
| }</code></pre></div> |
| <p>This library is currently split into a few core modules:</p> |
| <ul> |
| <li> |
| <p><a href="parser/index.html"><code>parser</code></a> is where you will find all the parsers that combine provides. It contains the core |
| <a href="parser/trait.Parser.html"><code>Parser</code></a> trait as well as several submodules such as <code>sequence</code> or <code>choice</code> which each |
| contain several parsers aimed at a specific niche.</p> |
| </li> |
| <li> |
| <p><a href="stream/trait.Stream.html"><code>stream</code></a> contains the second most important trait next to <a href="parser/trait.Parser.html"><code>Parser</code></a>. Streams represent the |
| data source which is being parsed such as <code>&[u8]</code>, <code>&str</code> or iterators.</p> |
| </li> |
| <li> |
| <p><a href="easy/index.html"><code>easy</code></a> contains combine’s default “easy” error and stream handling. If you use the |
| <code>easy_parse</code> method to start your parsing these are the types that are used.</p> |
| </li> |
| <li> |
| <p><a href="error/index.html"><code>error</code></a> contains the types and traits that make up combine’s error handling. Unless you |
| need to customize the errors your parsers return you should not need to use this module much.</p> |
| </li> |
| </ul> |
| <h2 id="examples"><a href="#examples">Examples</a></h2> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">extern crate </span>combine; |
| <span class="kw">use </span>combine::parser::char::{spaces, digit, char}; |
| <span class="kw">use </span>combine::{many1, sep_by, Parser, EasyParser}; |
| <span class="kw">use </span>combine::stream::easy; |
| |
| <span class="kw">fn </span>main() { |
| <span class="comment">//Parse spaces first and use the with method to only keep the result of the next parser |
| </span><span class="kw">let </span>integer = spaces() |
| <span class="comment">//parse a string of digits into an i32 |
| </span>.with(many1(digit()).map(|string: String| string.parse::<i32>().unwrap())); |
| |
| <span class="comment">//Parse integers separated by commas, skipping whitespace |
| </span><span class="kw">let </span><span class="kw-2">mut </span>integer_list = sep_by(integer, spaces().skip(char(<span class="string">','</span>))); |
| |
| <span class="comment">//Call parse with the input to execute the parser |
| </span><span class="kw">let </span>input = <span class="string">"1234, 45,78"</span>; |
| <span class="kw">let </span>result: <span class="prelude-ty">Result</span><(Vec<i32>, <span class="kw-2">&</span>str), easy::ParseError<<span class="kw-2">&</span>str>> = |
| integer_list.easy_parse(input); |
| <span class="kw">match </span>result { |
| <span class="prelude-val">Ok</span>((value, _remaining_input)) => <span class="macro">println!</span>(<span class="string">"{:?}"</span>, value), |
| <span class="prelude-val">Err</span>(err) => <span class="macro">println!</span>(<span class="string">"{}"</span>, err) |
| } |
| }</code></pre></div> |
| <p>If we need a parser that is mutually recursive or if we want to export a reusable parser the |
| <a href="macro.parser.html"><code>parser!</code></a> macro can be used. In effect it makes it possible to return a parser without naming |
| the type of the parser (which can be very large due to combine’s trait based approach). While |
| it is possible to do avoid naming the type without the macro those solutions require either allocation |
| (<code>Box<dyn Parser< Input, Output = O, PartialState = P>></code>) or nightly rust via <code>impl Trait</code>. The |
| macro thus threads the needle and makes it possible to have non-allocating, anonymous parsers |
| on stable rust.</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attribute">#[macro_use] |
| </span><span class="kw">extern crate </span>combine; |
| <span class="kw">use </span>combine::parser::char::{char, letter, spaces}; |
| <span class="kw">use </span>combine::{between, choice, many1, parser, sep_by, Parser, EasyParser}; |
| <span class="kw">use </span>combine::error::{ParseError, StdParseResult}; |
| <span class="kw">use </span>combine::stream::{Stream, Positioned}; |
| <span class="kw">use </span>combine::stream::position; |
| |
| <span class="attribute">#[derive(Debug, PartialEq)] |
| </span><span class="kw">pub enum </span>Expr { |
| Id(String), |
| Array(Vec<Expr>), |
| Pair(Box<Expr>, Box<Expr>) |
| } |
| |
| <span class="comment">// `impl Parser` can be used to create reusable parsers with zero overhead |
| </span><span class="kw">fn </span>expr_<Input>() -> <span class="kw">impl </span>Parser< Input, Output = Expr> |
| <span class="kw">where </span>Input: Stream<Token = char>, |
| <span class="comment">// Necessary due to rust-lang/rust#24159 |
| </span>Input::Error: ParseError<Input::Token, Input::Range, Input::Position>, |
| { |
| <span class="kw">let </span>word = many1(letter()); |
| |
| <span class="comment">// A parser which skips past whitespace. |
| // Since we aren't interested in knowing that our expression parser |
| // could have accepted additional whitespace between the tokens we also silence the error. |
| </span><span class="kw">let </span>skip_spaces = || spaces().silent(); |
| |
| <span class="comment">//Creates a parser which parses a char and skips any trailing whitespace |
| </span><span class="kw">let </span>lex_char = |c| char(c).skip(skip_spaces()); |
| |
| <span class="kw">let </span>comma_list = sep_by(expr(), lex_char(<span class="string">','</span>)); |
| <span class="kw">let </span>array = between(lex_char(<span class="string">'['</span>), lex_char(<span class="string">']'</span>), comma_list); |
| |
| <span class="comment">//We can use tuples to run several parsers in sequence |
| //The resulting type is a tuple containing each parsers output |
| </span><span class="kw">let </span>pair = (lex_char(<span class="string">'('</span>), |
| expr(), |
| lex_char(<span class="string">','</span>), |
| expr(), |
| lex_char(<span class="string">')'</span>)) |
| .map(|t| Expr::Pair(Box::new(t.<span class="number">1</span>), Box::new(t.<span class="number">3</span>))); |
| |
| choice(( |
| word.map(Expr::Id), |
| array.map(Expr::Array), |
| pair, |
| )) |
| .skip(skip_spaces()) |
| } |
| |
| <span class="comment">// As this expression parser needs to be able to call itself recursively `impl Parser` can't |
| // be used on its own as that would cause an infinitely large type. We can avoid this by using |
| // the `parser!` macro which erases the inner type and the size of that type entirely which |
| // lets it be used recursively. |
| // |
| // (This macro does not use `impl Trait` which means it can be used in rust < 1.26 as well to |
| // emulate `impl Parser`) |
| </span><span class="macro">parser!</span>{ |
| <span class="kw">fn </span>expr[Input]()(Input) -> Expr |
| <span class="kw">where </span>[Input: Stream<Token = char>] |
| { |
| expr_() |
| } |
| } |
| |
| <span class="kw">fn </span>main() { |
| <span class="kw">let </span>result = expr() |
| .parse(<span class="string">"[[], (hello, world), [rust]]"</span>); |
| <span class="kw">let </span>expr = Expr::Array(<span class="macro">vec!</span>[ |
| Expr::Array(Vec::new()) |
| , Expr::Pair(Box::new(Expr::Id(<span class="string">"hello"</span>.to_string())), |
| Box::new(Expr::Id(<span class="string">"world"</span>.to_string()))) |
| , Expr::Array(<span class="macro">vec!</span>[Expr::Id(<span class="string">"rust"</span>.to_string())]) |
| ]); |
| <span class="macro">assert_eq!</span>(result, <span class="prelude-val">Ok</span>((expr, <span class="string">""</span>))); |
| }</code></pre></div> |
| </div></details><h2 id="modules" class="small-section-header"><a href="#modules">Modules</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="mod" href="error/index.html" title="combine::error mod">error</a></div><div class="item-right docblock-short">Error types and traits which define what kind of errors combine parsers may emit</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="parser/index.html" title="combine::parser mod">parser</a></div><div class="item-right docblock-short">A collection of both concrete parsers as well as parser combinators.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="stream/index.html" title="combine::stream mod">stream</a></div><div class="item-right docblock-short">Streams are similar to the <code>Iterator</code> trait in that they represent some sequential set of items |
| which can be retrieved one by one. Where <code>Stream</code>s differ is that they are allowed to return |
| errors instead of just <code>None</code> and if they implement the <code>RangeStreamOnce</code> trait they are also |
| capable of returning multiple items at the same time, usually in the form of a slice.</div></div></div><h2 id="macros" class="small-section-header"><a href="#macros">Macros</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="macro" href="macro.choice.html" title="combine::choice macro">choice</a></div><div class="item-right docblock-short">Takes a number of parsers and tries to apply them each in order. |
| Fails if all the parsers fails or if an applied parser fails after it has committed to its |
| parse.</div></div><div class="item-row"><div class="item-left module-item"><a class="macro" href="macro.dispatch.html" title="combine::dispatch macro">dispatch</a></div><div class="item-right docblock-short"><code>dispatch!</code> allows a parser to be constructed depending on earlier input, without forcing each |
| branch to have the same type of parser</div></div><div class="item-row"><div class="item-left module-item"><a class="macro" href="macro.opaque.html" title="combine::opaque macro">opaque</a></div><div class="item-right docblock-short">Convenience macro over <a href="parser/combinator/fn.opaque.html"><code>opaque</code></a>.</div></div><div class="item-row"><div class="item-left module-item"><a class="macro" href="macro.parser.html" title="combine::parser macro">parser</a></div><div class="item-right docblock-short">Declares a named parser which can easily be reused.</div></div><div class="item-row"><div class="item-left module-item"><a class="macro" href="macro.struct_parser.html" title="combine::struct_parser macro">struct_parser</a></div><div class="item-right docblock-short">Sequences multiple parsers and builds a struct out of them.</div></div></div><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.ParseResult.html" title="combine::ParseResult enum">ParseResult</a></div><div class="item-right docblock-short">A <code>Result</code> type which has the committed status flattened into the result. |
| Conversions to and from <code>std::result::Result</code> can be done using <code>result.into()</code> or |
| <code>From::from(result)</code></div></div></div><h2 id="traits" class="small-section-header"><a href="#traits">Traits</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.ParseError.html" title="combine::ParseError trait">ParseError</a></div><div class="item-right docblock-short">Trait which defines a combine parse error.</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.Parser.html" title="combine::Parser trait">Parser</a></div><div class="item-right docblock-short">By implementing the <code>Parser</code> trait a type says that it can be used to parse an input stream |
| into the type <code>Output</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.Positioned.html" title="combine::Positioned trait">Positioned</a></div><div class="item-right docblock-short">A type which has a position.</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.RangeStream.html" title="combine::RangeStream trait">RangeStream</a></div><div class="item-right docblock-short">A <code>RangeStream</code> is an extension of <code>Stream</code> which allows for zero copy parsing.</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.RangeStreamOnce.html" title="combine::RangeStreamOnce trait">RangeStreamOnce</a></div><div class="item-right docblock-short">A <code>RangeStream</code> is an extension of <code>StreamOnce</code> which allows for zero copy parsing.</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.Stream.html" title="combine::Stream trait">Stream</a></div><div class="item-right docblock-short">A stream of tokens which can be duplicated</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.StreamOnce.html" title="combine::StreamOnce trait">StreamOnce</a></div><div class="item-right docblock-short"><code>StreamOnce</code> represents a sequence of items that can be extracted one by one.</div></div></div><h2 id="functions" class="small-section-header"><a href="#functions">Functions</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.any.html" title="combine::any fn">any</a></div><div class="item-right docblock-short">Parses any token.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.attempt.html" title="combine::attempt fn">attempt</a></div><div class="item-right docblock-short"><code>attempt(p)</code> behaves as <code>p</code> except it always acts as <code>p</code> peeked instead of committed on its |
| parse.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.between.html" title="combine::between fn">between</a></div><div class="item-right docblock-short">Parses <code>open</code> followed by <code>parser</code> followed by <code>close</code>. |
| Returns the value of <code>parser</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.chainl1.html" title="combine::chainl1 fn">chainl1</a></div><div class="item-right docblock-short">Parses <code>p</code> 1 or more times separated by <code>op</code>. The value returned is the one produced by the |
| left associative application of the function returned by the parser <code>op</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.chainr1.html" title="combine::chainr1 fn">chainr1</a></div><div class="item-right docblock-short">Parses <code>p</code> one or more times separated by <code>op</code>. The value returned is the one produced by the |
| right associative application of the function returned by <code>op</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.choice.html" title="combine::choice fn">choice</a></div><div class="item-right docblock-short">Takes a tuple, a slice or an array of parsers and tries to apply them each in order. |
| Fails if all the parsers fails or if an applied parser consumes input before failing.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.count.html" title="combine::count fn">count</a></div><div class="item-right docblock-short">Parses <code>parser</code> from zero up to <code>count</code> times.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.count_min_max.html" title="combine::count_min_max fn">count_min_max</a></div><div class="item-right docblock-short">Parses <code>parser</code> from <code>min</code> to <code>max</code> times (including <code>min</code> and <code>max</code>).</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.eof.html" title="combine::eof fn">eof</a></div><div class="item-right docblock-short">Succeeds only if the stream is at end of input, fails otherwise.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.from_str.html" title="combine::from_str fn">from_str</a></div><div class="item-right docblock-short">Takes a parser that outputs a string like value (<code>&str</code>, <code>String</code>, <code>&[u8]</code> or <code>Vec<u8></code>) and parses it |
| using <code>std::str::FromStr</code>. Errors if the output of <code>parser</code> is not UTF-8 or if |
| <code>FromStr::from_str</code> returns an error.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.look_ahead.html" title="combine::look_ahead fn">look_ahead</a></div><div class="item-right docblock-short"><code>look_ahead(p)</code> acts as <code>p</code> but doesn’t consume input on success.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.many.html" title="combine::many fn">many</a></div><div class="item-right docblock-short">Parses <code>p</code> zero or more times returning a collection with the values from <code>p</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.many1.html" title="combine::many1 fn">many1</a></div><div class="item-right docblock-short">Parses <code>p</code> one or more times returning a collection with the values from <code>p</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.none_of.html" title="combine::none_of fn">none_of</a></div><div class="item-right docblock-short">Extract one token and succeeds if it is not part of <code>tokens</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.not_followed_by.html" title="combine::not_followed_by fn">not_followed_by</a></div><div class="item-right docblock-short">Succeeds only if <code>parser</code> fails. |
| Never consumes any input.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.one_of.html" title="combine::one_of fn">one_of</a></div><div class="item-right docblock-short">Extract one token and succeeds if it is part of <code>tokens</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.optional.html" title="combine::optional fn">optional</a></div><div class="item-right docblock-short">Parses <code>parser</code> and outputs <code>Some(value)</code> if it succeeds, <code>None</code> if it fails without |
| consuming any input. Fails if <code>parser</code> fails after having committed some input.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.parser.html" title="combine::parser fn">parser</a></div><div class="item-right docblock-short">Wraps a function, turning it into a parser.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.position.html" title="combine::position fn">position</a></div><div class="item-right docblock-short">Parser which just returns the current position in the stream.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.produce.html" title="combine::produce fn">produce</a></div><div class="item-right docblock-short">Always returns the value produced by calling <code>f</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.satisfy.html" title="combine::satisfy fn">satisfy</a></div><div class="item-right docblock-short">Parses a token and succeeds depending on the result of <code>predicate</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.satisfy_map.html" title="combine::satisfy_map fn">satisfy_map</a></div><div class="item-right docblock-short">Parses a token and passes it to <code>predicate</code>. If <code>predicate</code> returns <code>Some</code> the parser succeeds |
| and returns the value inside the <code>Option</code>. If <code>predicate</code> returns <code>None</code> the parser fails |
| without consuming any input.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.sep_by.html" title="combine::sep_by fn">sep_by</a></div><div class="item-right docblock-short">Parses <code>parser</code> zero or more time separated by <code>separator</code>, returning a collection with the |
| values from <code>p</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.sep_by1.html" title="combine::sep_by1 fn">sep_by1</a></div><div class="item-right docblock-short">Parses <code>parser</code> one or more time separated by <code>separator</code>, returning a collection with the |
| values from <code>p</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.sep_end_by.html" title="combine::sep_end_by fn">sep_end_by</a></div><div class="item-right docblock-short">Parses <code>parser</code> zero or more times separated and ended by <code>separator</code>, returning a collection |
| with the values from <code>p</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.sep_end_by1.html" title="combine::sep_end_by1 fn">sep_end_by1</a></div><div class="item-right docblock-short">Parses <code>parser</code> one or more times separated and ended by <code>separator</code>, returning a collection |
| with the values from <code>p</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.skip_count.html" title="combine::skip_count fn">skip_count</a></div><div class="item-right docblock-short">Parses <code>parser</code> from zero up to <code>count</code> times skipping the output of <code>parser</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.skip_count_min_max.html" title="combine::skip_count_min_max fn">skip_count_min_max</a></div><div class="item-right docblock-short">Parses <code>parser</code> from <code>min</code> to <code>max</code> times (including <code>min</code> and <code>max</code>) |
| skipping the output of <code>parser</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.skip_many.html" title="combine::skip_many fn">skip_many</a></div><div class="item-right docblock-short">Parses <code>p</code> zero or more times ignoring the result.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.skip_many1.html" title="combine::skip_many1 fn">skip_many1</a></div><div class="item-right docblock-short">Parses <code>p</code> one or more times ignoring the result.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.token.html" title="combine::token fn">token</a></div><div class="item-right docblock-short">Parses a character and succeeds if the character is equal to <code>c</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.tokens.html" title="combine::tokens fn">tokens</a></div><div class="item-right docblock-short">Parses multiple tokens.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.tokens_cmp.html" title="combine::tokens_cmp fn">tokens_cmp</a></div><div class="item-right docblock-short">Parses multiple tokens.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.unexpected.html" title="combine::unexpected fn">unexpected</a></div><div class="item-right docblock-short">Always fails with <code>message</code> as an unexpected error. |
| Never consumes any input.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.unexpected_any.html" title="combine::unexpected_any fn">unexpected_any</a></div><div class="item-right docblock-short">Always fails with <code>message</code> as an unexpected error. |
| Never consumes any input.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.value.html" title="combine::value fn">value</a></div><div class="item-right docblock-short">Always returns the value <code>v</code> without consuming any input.</div></div></div><h2 id="types" class="small-section-header"><a href="#types">Type Definitions</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="type" href="type.StdParseResult.html" title="combine::StdParseResult type">StdParseResult</a></div><div class="item-right docblock-short">A type alias over the specific <code>Result</code> type used by parsers to indicate whether they were |
| successful or not. |
| <code>O</code> is the type that is output on success. |
| <code>Input</code> is the specific stream type used in the parser.</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="combine" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
