235 lines
No EOL
20 KiB
HTML
235 lines
No EOL
20 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="API documentation for the Rust `parser` macro in crate `combine`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, parser">
|
||
|
||
<title>combine::parser - 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>
|
||
|
||
|
||
|
||
|
||
</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>
|
||
|
||
<div class="sidebar-elems"><p class='location'><a href='index.html'>combine</a></p><script>window.sidebarCurrent = {name: 'parser', 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 js-only">
|
||
<div class="search-container">
|
||
<input class="search-input" name="search"
|
||
autocomplete="off"
|
||
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
|
||
type="search">
|
||
</div>
|
||
</form>
|
||
</nav>
|
||
|
||
<section id='main' class="content"><h1 class='fqn'><span class='in-band'>Macro <a href='index.html'>combine</a>::<wbr><a class="macro" href=''>parser</a></span><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/combine/lib.rs.html#272-365' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class="rust macro">
|
||
<span class="macro">macro_rules</span><span class="macro">!</span> <span class="ident">parser</span> {
|
||
(
|
||
$(<span class="attribute">#[<span class="macro-nonterminal">$</span><span class="macro-nonterminal">attr</span>:<span class="ident">meta</span>]</span>)<span class="op">*</span>
|
||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>: <span class="ident">ident</span> [$(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">type_params</span>: <span class="ident">tt</span>)<span class="kw-2">*</span>]( $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">arg</span>: <span class="ident">ident</span> : <span class="macro-nonterminal">$</span><span class="macro-nonterminal">arg_type</span>: <span class="ident">ty</span>),<span class="op">*</span> )
|
||
(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">input_type</span>: <span class="ident">ty</span>) <span class="op">-></span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">output_type</span>: <span class="ident">ty</span>
|
||
{ $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">parser</span>: <span class="ident">tt</span>)<span class="op">*</span> }
|
||
) <span class="op">=></span> { ... };
|
||
(
|
||
$(<span class="attribute">#[<span class="macro-nonterminal">$</span><span class="macro-nonterminal">attr</span>:<span class="ident">meta</span>]</span>)<span class="op">*</span>
|
||
<span class="kw">fn</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>: <span class="ident">ident</span> [$(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">type_params</span>: <span class="ident">tt</span>)<span class="kw-2">*</span>]( $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">arg</span>: <span class="ident">ident</span> : <span class="macro-nonterminal">$</span><span class="macro-nonterminal">arg_type</span>: <span class="ident">ty</span>),<span class="op">*</span> )
|
||
(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">input_type</span>: <span class="ident">ty</span>) <span class="op">-></span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">output_type</span>: <span class="ident">ty</span>
|
||
{ $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">parser</span>: <span class="ident">tt</span>)<span class="op">*</span> }
|
||
) <span class="op">=></span> { ... };
|
||
(
|
||
$(<span class="attribute">#[<span class="macro-nonterminal">$</span><span class="macro-nonterminal">attr</span>:<span class="ident">meta</span>]</span>)<span class="op">*</span>
|
||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>: <span class="ident">ident</span> [$(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">type_params</span>: <span class="ident">tt</span>)<span class="kw-2">*</span>]( $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">arg</span>: <span class="ident">ident</span> : <span class="macro-nonterminal">$</span><span class="macro-nonterminal">arg_type</span>: <span class="ident">ty</span>),<span class="op">*</span> )
|
||
(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">input_type</span>: <span class="ident">ty</span>) <span class="op">-></span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">output_type</span>: <span class="ident">ty</span>
|
||
<span class="kw">where</span> [$(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">where_clause</span>: <span class="ident">tt</span>)<span class="kw-2">*</span>]
|
||
{ $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">parser</span>: <span class="ident">tt</span>)<span class="op">*</span> }
|
||
) <span class="op">=></span> { ... };
|
||
(
|
||
$(<span class="attribute">#[<span class="macro-nonterminal">$</span><span class="macro-nonterminal">attr</span>:<span class="ident">meta</span>]</span>)<span class="op">*</span>
|
||
<span class="kw">fn</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>: <span class="ident">ident</span> [$(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">type_params</span>: <span class="ident">tt</span>)<span class="kw-2">*</span>]( $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">arg</span>: <span class="ident">ident</span> : <span class="macro-nonterminal">$</span><span class="macro-nonterminal">arg_type</span>: <span class="ident">ty</span>),<span class="kw-2">*</span>) (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">input_type</span>: <span class="ident">ty</span>) <span class="op">-></span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">output_type</span>: <span class="ident">ty</span>
|
||
<span class="kw">where</span> [$(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">where_clause</span>: <span class="ident">tt</span>)<span class="kw-2">*</span>]
|
||
{ $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">parser</span>: <span class="ident">tt</span>)<span class="op">*</span> }
|
||
) <span class="op">=></span> { ... };
|
||
(
|
||
$(<span class="attribute">#[<span class="macro-nonterminal">$</span><span class="macro-nonterminal">derive</span>:<span class="ident">meta</span>]</span>)<span class="op">*</span>
|
||
<span class="kw">pub</span> <span class="kw">struct</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">type_name</span>: <span class="ident">ident</span>;
|
||
$(<span class="attribute">#[<span class="macro-nonterminal">$</span><span class="macro-nonterminal">attr</span>:<span class="ident">meta</span>]</span>)<span class="op">*</span>
|
||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>: <span class="ident">ident</span> [$(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">type_params</span>: <span class="ident">tt</span>)<span class="kw-2">*</span>]( $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">arg</span>: <span class="ident">ident</span> : <span class="macro-nonterminal">$</span><span class="macro-nonterminal">arg_type</span>: <span class="ident">ty</span>),<span class="op">*</span> )
|
||
(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">input_type</span>: <span class="ident">ty</span>) <span class="op">-></span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">output_type</span>: <span class="ident">ty</span>
|
||
<span class="kw">where</span> [$(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">where_clause</span>: <span class="ident">tt</span>)<span class="kw-2">*</span>]
|
||
{ $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">parser</span>: <span class="ident">tt</span>)<span class="op">*</span> }
|
||
) <span class="op">=></span> { ... };
|
||
(
|
||
$(<span class="attribute">#[<span class="macro-nonterminal">$</span><span class="macro-nonterminal">derive</span>:<span class="ident">meta</span>]</span>)<span class="op">*</span>
|
||
<span class="kw">struct</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">type_name</span>: <span class="ident">ident</span>;
|
||
$(<span class="attribute">#[<span class="macro-nonterminal">$</span><span class="macro-nonterminal">attr</span>:<span class="ident">meta</span>]</span>)<span class="op">*</span>
|
||
<span class="kw">fn</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>: <span class="ident">ident</span> [$(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">type_params</span>: <span class="ident">tt</span>)<span class="kw-2">*</span>]( $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">arg</span>: <span class="ident">ident</span> : <span class="macro-nonterminal">$</span><span class="macro-nonterminal">arg_type</span>: <span class="ident">ty</span>),<span class="kw-2">*</span>) (<span class="macro-nonterminal">$</span><span class="macro-nonterminal">input_type</span>: <span class="ident">ty</span>) <span class="op">-></span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">output_type</span>: <span class="ident">ty</span>
|
||
<span class="kw">where</span> [$(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">where_clause</span>: <span class="ident">tt</span>)<span class="kw-2">*</span>]
|
||
{ $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">parser</span>: <span class="ident">tt</span>)<span class="op">*</span> }
|
||
) <span class="op">=></span> { ... };
|
||
}</pre>
|
||
</div><div class='docblock'><p>Declares a named parser which can easily be reused.</p>
|
||
<p>The expression which creates the parser should have no side effects as it may be called
|
||
multiple times even during a single parse attempt.</p>
|
||
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="attribute">#[<span class="ident">macro_use</span>]</span>
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">combine</span>;
|
||
<span class="kw">use</span> <span class="ident">combine</span>::<span class="ident">char</span>::<span class="ident">digit</span>;
|
||
<span class="kw">use</span> <span class="ident">combine</span>::{<span class="ident">any</span>, <span class="ident">choice</span>, <span class="ident">many1</span>, <span class="ident">Parser</span>, <span class="ident">Stream</span>};
|
||
|
||
<span class="macro">parser</span><span class="macro">!</span>{
|
||
<span class="kw">fn</span> <span class="ident">integer</span>[<span class="ident">I</span>]()(<span class="ident">I</span>) <span class="op">-></span> <span class="ident">i32</span>
|
||
<span class="kw">where</span> [<span class="ident">I</span>: <span class="ident">Stream</span><span class="op"><</span><span class="ident">Item</span> <span class="op">=</span> <span class="ident">char</span><span class="op">></span>]
|
||
{
|
||
<span class="comment">// The body must be a block body ( `{ <block body> }`) which ends with an expression</span>
|
||
<span class="comment">// which evaluates to a parser</span>
|
||
<span class="kw">let</span> <span class="ident">digits</span> <span class="op">=</span> <span class="ident">many1</span>(<span class="ident">digit</span>());
|
||
<span class="ident">digits</span>.<span class="ident">and_then</span>(<span class="op">|</span><span class="ident">s</span>: <span class="ident">String</span><span class="op">|</span> <span class="ident">s</span>.<span class="ident">parse</span>())
|
||
}
|
||
}
|
||
|
||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">PartialEq</span>)]</span>
|
||
<span class="kw">pub</span> <span class="kw">enum</span> <span class="ident">IntOrString</span> {
|
||
<span class="ident">Int</span>(<span class="ident">i32</span>),
|
||
<span class="ident">String</span>(<span class="ident">String</span>),
|
||
}
|
||
<span class="comment">// prefix with `pub` to declare a public parser</span>
|
||
<span class="macro">parser</span><span class="macro">!</span>{
|
||
<span class="comment">// Documentation comments works as well</span>
|
||
|
||
<span class="doccomment">/// Parses an integer or a string (any characters)</span>
|
||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">integer_or_string</span>[<span class="ident">I</span>]()(<span class="ident">I</span>) <span class="op">-></span> <span class="ident">IntOrString</span>
|
||
<span class="kw">where</span> [<span class="ident">I</span>: <span class="ident">Stream</span><span class="op"><</span><span class="ident">Item</span> <span class="op">=</span> <span class="ident">char</span><span class="op">></span>]
|
||
{
|
||
<span class="macro">choice</span><span class="macro">!</span>(
|
||
<span class="ident">integer</span>().<span class="ident">map</span>(<span class="ident">IntOrString</span>::<span class="ident">Int</span>),
|
||
<span class="ident">many1</span>(<span class="ident">any</span>()).<span class="ident">map</span>(<span class="ident">IntOrString</span>::<span class="ident">String</span>)
|
||
)
|
||
}
|
||
}
|
||
|
||
<span class="macro">parser</span><span class="macro">!</span>{
|
||
<span class="comment">// Give the created type a unique name</span>
|
||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Clone</span>)]</span>
|
||
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Twice</span>;
|
||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">twice</span>[<span class="ident">F</span>, <span class="ident">P</span>](<span class="ident">f</span>: <span class="ident">F</span>)(<span class="ident">P</span>::<span class="ident">Input</span>) <span class="op">-></span> (<span class="ident">P</span>::<span class="ident">Output</span>, <span class="ident">P</span>::<span class="ident">Output</span>)
|
||
<span class="kw">where</span> [<span class="ident">P</span>: <span class="ident">Parser</span>,
|
||
<span class="ident">F</span>: <span class="ident">FnMut</span>() <span class="op">-></span> <span class="ident">P</span>]
|
||
{
|
||
(<span class="ident">f</span>(), <span class="ident">f</span>())
|
||
}
|
||
}
|
||
|
||
<span class="kw">fn</span> <span class="ident">main</span>() {
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">integer</span>().<span class="ident">parse</span>(<span class="string">"123"</span>), <span class="prelude-val">Ok</span>((<span class="number">123</span>, <span class="string">""</span>)));
|
||
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">integer</span>().<span class="ident">parse</span>(<span class="string">"!"</span>).<span class="ident">is_err</span>());
|
||
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">integer_or_string</span>().<span class="ident">parse</span>(<span class="string">"123"</span>), <span class="prelude-val">Ok</span>((<span class="ident">IntOrString</span>::<span class="ident">Int</span>(<span class="number">123</span>), <span class="string">""</span>)));
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(
|
||
<span class="ident">integer_or_string</span>().<span class="ident">parse</span>(<span class="string">"abc"</span>),
|
||
<span class="prelude-val">Ok</span>((<span class="ident">IntOrString</span>::<span class="ident">String</span>(<span class="string">"abc"</span>.<span class="ident">to_string</span>()), <span class="string">""</span>))
|
||
);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">twice</span>(<span class="op">||</span> <span class="ident">digit</span>()).<span class="ident">parse</span>(<span class="string">"123"</span>), <span class="prelude-val">Ok</span>(((<span class="string">'1'</span>, <span class="string">'2'</span>), <span class="string">"3"</span>)));
|
||
}</pre>
|
||
</div></section>
|
||
<section id='search' class="content hidden"></section>
|
||
|
||
<section class="footer"></section>
|
||
|
||
<aside id="help" class="hidden">
|
||
<div>
|
||
<h1 class="hidden">Help</h1>
|
||
|
||
<div class="shortcuts">
|
||
<h2>Keyboard Shortcuts</h2>
|
||
|
||
<dl>
|
||
<dt><kbd>?</kbd></dt>
|
||
<dd>Show this help dialog</dd>
|
||
<dt><kbd>S</kbd></dt>
|
||
<dd>Focus the search field</dd>
|
||
<dt><kbd>↑</kbd></dt>
|
||
<dd>Move up in search results</dd>
|
||
<dt><kbd>↓</kbd></dt>
|
||
<dd>Move down in search results</dd>
|
||
<dt><kbd>↹</kbd></dt>
|
||
<dd>Switch tab</dd>
|
||
<dt><kbd>⏎</kbd></dt>
|
||
<dd>Go to active search result</dd>
|
||
<dt><kbd>+</kbd></dt>
|
||
<dd>Expand all sections</dd>
|
||
<dt><kbd>-</kbd></dt>
|
||
<dd>Collapse all sections</dd>
|
||
</dl>
|
||
</div>
|
||
|
||
<div class="infos">
|
||
<h2>Search Tricks</h2>
|
||
|
||
<p>
|
||
Prefix searches with a type followed by a colon (e.g.
|
||
<code>fn:</code>) to restrict the search to a given type.
|
||
</p>
|
||
|
||
<p>
|
||
Accepted types are: <code>fn</code>, <code>mod</code>,
|
||
<code>struct</code>, <code>enum</code>,
|
||
<code>trait</code>, <code>type</code>, <code>macro</code>,
|
||
and <code>const</code>.
|
||
</p>
|
||
|
||
<p>
|
||
Search functions by type signature (e.g.
|
||
<code>vec -> usize</code> or <code>* -> vec</code>)
|
||
</p>
|
||
</div>
|
||
</div>
|
||
</aside>
|
||
|
||
|
||
|
||
<script>
|
||
window.rootPath = "../";
|
||
window.currentCrate = "combine";
|
||
</script>
|
||
<script src="../main.js"></script>
|
||
<script defer src="../search-index.js"></script>
|
||
</body>
|
||
</html> |