edg-l/edlang
1
1
Fork 0
mirror of https://github.com/edg-l/edlang.git synced 2024-11-15 04:28:25 +00:00
Code Issues Packages Projects Releases Wiki Activity
edlang/winnow/combinator/fn.permutation.html

41 lines
7.6 KiB
HTML
Raw Normal View History

deploy: 03a244db41b752280f505ceeaea877cc9b95537b
2024-05-05 09:43:20 +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="Applies a list of parsers in any order."><title>permutation in winnow::combinator - Rust</title><script> if (window.location.protocol !== "file:") document.write(`<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">`)</script><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-e935ef01ae1c1829.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.78.0 (9b00956e5 2024-04-29)" data-channel="1.78.0" data-search-js="search-42d8da7a6b9792c2.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-4c98445ec4002617.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-12cf3b4f4f9dc36d.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-04d5337699b92874.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" 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.7</span></h2></div><div class="sidebar-elems"><h2><a href="index.html">In winnow::combinator</a></h2></div></nav><div class="sidebar-resizer"></div>
deploy: 22498719e1dbb1ddc4a5584a4fcba2f337ccb991
2024-03-11 08:39:13 +00:00
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../winnow/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">winnow</a>::<wbr><a href="index.html">combinator</a>::<wbr><a class="fn" href="#">permutation</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/winnow/combinator/branch.rs.html#121-125">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub fn permutation&lt;I: <a class="trait" href="../stream/trait.Stream.html" title="trait winnow::stream::Stream">Stream</a>, O, E: <a class="trait" href="../error/trait.ParserError.html" title="trait winnow::error::ParserError">ParserError</a>&lt;I&gt;, List: <a class="trait" href="trait.Permutation.html" title="trait winnow::combinator::Permutation">Permutation</a>&lt;I, O, E&gt;&gt;(
l: List
) -&gt; impl <a class="trait" href="../trait.Parser.html" title="trait winnow::Parser">Parser</a>&lt;I, O, E&gt;</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Applies a list of parsers in any order.</p>
<p>Permutation will succeed if all of the child parsers succeeded.
It takes as argument a tuple of parsers, and returns a
tuple of the parser results.</p>
<p>To stop on an error, rather than trying further permutations, see
<a href="fn.cut_err.html" title="fn winnow::combinator::cut_err"><code>cut_err</code></a> ([example][crate::_tutorial::chapter_6]).</p>
deploy: 39fc7f2b9fd58ce67982b1c71c788f3b031ae3df
2024-03-27 11:12:16 +00:00
<h2 id="example"><a class="doc-anchor" href="#example">§</a>Example</h2>
deploy: 22498719e1dbb1ddc4a5584a4fcba2f337ccb991
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::ascii::{alpha1, digit1};
<span class="kw">use </span>winnow::combinator::permutation;
<span class="kw">fn </span>parser(input: <span class="kw-2">&amp;</span>str) -&gt; IResult&lt;<span class="kw-2">&amp;</span>str, (<span class="kw-2">&amp;</span>str, <span class="kw-2">&amp;</span>str)&gt; {
permutation((alpha1, digit1)).parse_peek(input)
}
<span class="comment">// permutation recognizes alphabetic characters then digit
</span><span class="macro">assert_eq!</span>(parser(<span class="string">"abc123"</span>), <span class="prelude-val">Ok</span>((<span class="string">""</span>, (<span class="string">"abc"</span>, <span class="string">"123"</span>))));
<span class="comment">// but also in inverse order
</span><span class="macro">assert_eq!</span>(parser(<span class="string">"123abc"</span>), <span class="prelude-val">Ok</span>((<span class="string">""</span>, (<span class="string">"abc"</span>, <span class="string">"123"</span>))));
<span class="comment">// it will fail if one of the parsers failed
</span><span class="macro">assert_eq!</span>(parser(<span class="string">"abc;"</span>), <span class="prelude-val">Err</span>(ErrMode::Backtrack(InputError::new(<span class="string">";"</span>, ErrorKind::Slice))));</code></pre></div>
<p>The parsers are applied greedily: if there are multiple unapplied parsers
that could parse the next slice of input, the first one is used.</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>winnow::combinator::permutation;
<span class="kw">use </span>winnow::token::any;
<span class="kw">fn </span>parser(input: <span class="kw-2">&amp;</span>str) -&gt; IResult&lt;<span class="kw-2">&amp;</span>str, (char, char)&gt; {
permutation((any, <span class="string">'a'</span>)).parse_peek(input)
}
<span class="comment">// any parses 'b', then char('a') parses 'a'
</span><span class="macro">assert_eq!</span>(parser(<span class="string">"ba"</span>), <span class="prelude-val">Ok</span>((<span class="string">""</span>, (<span class="string">'b'</span>, <span class="string">'a'</span>))));
<span class="comment">// any parses 'a', then char('a') fails on 'b',
// even though char('a') followed by any would succeed
</span><span class="macro">assert_eq!</span>(parser(<span class="string">"ab"</span>), <span class="prelude-val">Err</span>(ErrMode::Backtrack(InputError::new(<span class="string">"b"</span>, ErrorKind::Tag))));</code></pre></div>
</div></details></section></div></main></body></html>
Reference in a new issue Copy permalink