doc: 2020-04-01 11:32:45 +0200: 478563f - Adding documentation
This commit is contained in:
63
nom/macro.permutation.html
Normal file
63
nom/macro.permutation.html
Normal file
@@ -0,0 +1,63 @@
|
||||
<!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="API documentation for the Rust `permutation` macro in crate `nom`."><meta name="keywords" content="rust, rustlang, rust-lang, permutation"><title>nom::permutation - Rust</title><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="../dark.css"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc macro"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../nom/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><div class="sidebar-elems"><p class='location'><a href='index.html'>nom</a></p><script>window.sidebarCurrent = {name: 'permutation', ty: 'macro', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../src/nom/branch.rs.html#563-602' title='goto source code'>[src]</a></span><span class='in-band'>Macro <a href='index.html'>nom</a>::<wbr><a class="macro" href=''>permutation</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><div class="example-wrap"><pre class="rust macro">
|
||||
<span class="macro">macro_rules</span><span class="macro">!</span> <span class="ident">permutation</span> {
|
||||
(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">i</span>:<span class="ident">expr</span>, $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">rest</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>) <span class="op">=</span><span class="op">></span> { ... };
|
||||
}</pre></div>
|
||||
</div><div class='docblock'><p><code>permutation!(I -> IResult<I,A>, I -> IResult<I,B>, ... I -> IResult<I,X> ) => I -> IResult<I, (A,B,...X)></code>
|
||||
applies its sub parsers in a sequence, but independent from their order
|
||||
this parser will only succeed if all of its sub parsers succeed</p>
|
||||
<p>the tuple of results is in the same order as the parsers are declared</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="macro">named</span><span class="macro">!</span>(<span class="ident">perm</span><span class="op"><</span>(<span class="kw-2">&</span>[<span class="ident">u8</span>], <span class="kw-2">&</span>[<span class="ident">u8</span>], <span class="kw-2">&</span>[<span class="ident">u8</span>])<span class="op">></span>,
|
||||
<span class="macro">permutation</span><span class="macro">!</span>(<span class="macro">tag</span><span class="macro">!</span>(<span class="string">"abcd"</span>), <span class="macro">tag</span><span class="macro">!</span>(<span class="string">"efg"</span>), <span class="macro">tag</span><span class="macro">!</span>(<span class="string">"hi"</span>))
|
||||
);
|
||||
|
||||
<span class="comment">// whatever the order, if the parser succeeds, each</span>
|
||||
<span class="comment">// tag should have matched correctly</span>
|
||||
<span class="kw">let</span> <span class="ident">expected</span> <span class="op">=</span> (<span class="kw-2">&</span><span class="string">b"abcd"</span>[..], <span class="kw-2">&</span><span class="string">b"efg"</span>[..], <span class="kw-2">&</span><span class="string">b"hi"</span>[..]);
|
||||
|
||||
<span class="kw">let</span> <span class="ident">a</span> <span class="op">=</span> <span class="kw-2">&</span><span class="string">b"abcdefghijk"</span>[..];
|
||||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">perm</span>(<span class="ident">a</span>), <span class="prelude-val">Ok</span>((<span class="kw-2">&</span><span class="string">b"jk"</span>[..], <span class="ident">expected</span>)));
|
||||
<span class="kw">let</span> <span class="ident">b</span> <span class="op">=</span> <span class="kw-2">&</span><span class="string">b"efgabcdhijkl"</span>[..];
|
||||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">perm</span>(<span class="ident">b</span>), <span class="prelude-val">Ok</span>((<span class="kw-2">&</span><span class="string">b"jkl"</span>[..], <span class="ident">expected</span>)));
|
||||
<span class="kw">let</span> <span class="ident">c</span> <span class="op">=</span> <span class="kw-2">&</span><span class="string">b"hiefgabcdjklm"</span>[..];
|
||||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">perm</span>(<span class="ident">c</span>), <span class="prelude-val">Ok</span>((<span class="kw-2">&</span><span class="string">b"jklm"</span>[..], <span class="ident">expected</span>)));
|
||||
|
||||
<span class="kw">let</span> <span class="ident">d</span> <span class="op">=</span> <span class="kw-2">&</span><span class="string">b"efgxyzabcdefghi"</span>[..];
|
||||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">perm</span>(<span class="ident">d</span>), <span class="prelude-val">Err</span>(<span class="prelude-val">Err</span>::<span class="ident">Error</span>(<span class="macro">error_node_position</span><span class="macro">!</span>(<span class="kw-2">&</span><span class="string">b"efgxyzabcdefghi"</span>[..], <span class="ident">ErrorKind</span>::<span class="ident">Permutation</span>,
|
||||
<span class="macro">error_position</span><span class="macro">!</span>(<span class="kw-2">&</span><span class="string">b"xyzabcdefghi"</span>[..], <span class="ident">ErrorKind</span>::<span class="ident">Permutation</span>)))));
|
||||
|
||||
<span class="kw">let</span> <span class="ident">e</span> <span class="op">=</span> <span class="kw-2">&</span><span class="string">b"efgabc"</span>[..];
|
||||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">perm</span>(<span class="ident">e</span>), <span class="prelude-val">Err</span>(<span class="prelude-val">Err</span>::<span class="ident">Incomplete</span>(<span class="ident">Needed</span>::<span class="ident">Size</span>(<span class="number">4</span>))));</pre></div>
|
||||
<p>If one of the child parsers is followed by a <code>?</code>, that parser is now
|
||||
optional:</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="macro">named</span><span class="macro">!</span>(<span class="ident">perm</span><span class="op"><</span><span class="kw-2">&</span><span class="ident">str</span>, (<span class="prelude-ty">Option</span><span class="op"><</span><span class="kw-2">&</span><span class="ident">str</span><span class="op">></span>, <span class="kw-2">&</span><span class="ident">str</span>, <span class="kw-2">&</span><span class="ident">str</span>)<span class="op">></span>,
|
||||
<span class="macro">permutation</span><span class="macro">!</span>(<span class="macro">tag</span><span class="macro">!</span>(<span class="string">"abcd"</span>)<span class="question-mark">?</span>, <span class="macro">tag</span><span class="macro">!</span>(<span class="string">"efg"</span>), <span class="macro">tag</span><span class="macro">!</span>(<span class="string">"hi"</span>))
|
||||
);
|
||||
|
||||
<span class="comment">// whatever the order, if the parser succeeds, each</span>
|
||||
<span class="comment">// tag should have matched correctly</span>
|
||||
<span class="kw">let</span> <span class="ident">expected</span> <span class="op">=</span> (<span class="prelude-val">Some</span>(<span class="string">"abcd"</span>), <span class="string">"efg"</span>, <span class="string">"hi"</span>);
|
||||
|
||||
<span class="kw">let</span> <span class="ident">a</span> <span class="op">=</span> <span class="string">"abcdefghijk"</span>;
|
||||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">perm</span>(<span class="ident">a</span>), <span class="prelude-val">Ok</span>((<span class="string">"jk"</span>, <span class="ident">expected</span>)));
|
||||
<span class="kw">let</span> <span class="ident">b</span> <span class="op">=</span> <span class="string">"efgabcdhijkl"</span>;
|
||||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">perm</span>(<span class="ident">b</span>), <span class="prelude-val">Ok</span>((<span class="string">"jkl"</span>, <span class="ident">expected</span>)));
|
||||
<span class="kw">let</span> <span class="ident">c</span> <span class="op">=</span> <span class="string">"hiefgabcdjklm"</span>;
|
||||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">perm</span>(<span class="ident">c</span>), <span class="prelude-val">Ok</span>((<span class="string">"jklm"</span>, <span class="ident">expected</span>)));
|
||||
|
||||
<span class="comment">// if `abcd` is missing:</span>
|
||||
<span class="kw">let</span> <span class="ident">expected</span> <span class="op">=</span> (<span class="prelude-val">None</span>, <span class="string">"efg"</span>, <span class="string">"hi"</span>);
|
||||
|
||||
<span class="kw">let</span> <span class="ident">a</span> <span class="op">=</span> <span class="string">"efghijk"</span>;
|
||||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">perm</span>(<span class="ident">a</span>), <span class="prelude-val">Ok</span>((<span class="string">"jk"</span>, <span class="ident">expected</span>)));
|
||||
<span class="kw">let</span> <span class="ident">b</span> <span class="op">=</span> <span class="string">"efghijkl"</span>;
|
||||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">perm</span>(<span class="ident">b</span>), <span class="prelude-val">Ok</span>((<span class="string">"jkl"</span>, <span class="ident">expected</span>)));
|
||||
<span class="kw">let</span> <span class="ident">c</span> <span class="op">=</span> <span class="string">"hiefgjklm"</span>;
|
||||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">perm</span>(<span class="ident">c</span>), <span class="prelude-val">Ok</span>((<span class="string">"jklm"</span>, <span class="ident">expected</span>)));
|
||||
|
||||
<span class="kw">let</span> <span class="ident">e</span> <span class="op">=</span> <span class="string">"efgabc"</span>;
|
||||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">perm</span>(<span class="ident">e</span>), <span class="prelude-val">Err</span>(<span class="prelude-val">Err</span>::<span class="ident">Incomplete</span>(<span class="ident">Needed</span>::<span class="ident">Size</span>(<span class="number">4</span>))));</pre></div>
|
||||
</div></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../";window.currentCrate = "nom";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>
|
||||
Reference in New Issue
Block a user