2017-07-14 23:24:09 +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">
|
2017-07-14 23:30:16 +00:00
|
|
|
|
<meta name="description" content="API documentation for the Rust `parse` mod in crate `syn`.">
|
|
|
|
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, parse">
|
2017-07-14 23:24:09 +00:00
|
|
|
|
|
2017-07-14 23:30:16 +00:00
|
|
|
|
<title>syn::parse - Rust</title>
|
2017-07-14 23:24:09 +00:00
|
|
|
|
|
|
|
|
|
|
<link rel="stylesheet" type="text/css" href="../../normalize.css">
|
|
|
|
|
|
<link rel="stylesheet" type="text/css" href="../../rustdoc.css">
|
|
|
|
|
|
<link rel="stylesheet" type="text/css" href="../../main.css">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</head>
|
|
|
|
|
|
<body class="rustdoc mod">
|
|
|
|
|
|
<!--[if lte IE 8]>
|
|
|
|
|
|
<div class="warning">
|
|
|
|
|
|
This old browser is unsupported and will most likely display funky
|
|
|
|
|
|
things.
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<![endif]-->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<nav class="sidebar">
|
|
|
|
|
|
|
2017-07-14 23:30:16 +00:00
|
|
|
|
<p class='location'>Module parse</p><div class="block items"><ul><li><a href="#enums">Enums</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'><a href='../index.html'>syn</a></p><script>window.sidebarCurrent = {name: 'parse', ty: 'mod', relpath: '../'};</script><script defer src="../sidebar-items.js"></script>
|
2017-07-14 23:24:09 +00:00
|
|
|
|
</nav>
|
|
|
|
|
|
|
|
|
|
|
|
<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">
|
2017-07-14 23:30:16 +00:00
|
|
|
|
<h1 class='fqn'><span class='in-band'>Module <a href='../index.html'>syn</a>::<wbr><a class="mod" href=''>parse</a></span><span class='out-of-band'><span id='render-detail'>
|
2017-07-14 23:24:09 +00:00
|
|
|
|
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
|
|
|
|
|
|
[<span class='inner'>−</span>]
|
|
|
|
|
|
</a>
|
2017-07-14 23:30:16 +00:00
|
|
|
|
</span><a class='srclink' href='../../src/syn/lib.rs.html#185-211' title='goto source code'>[src]</a></span></h1>
|
|
|
|
|
|
<div class='docblock'><p>This module contains a set of exported nom parsers which can be used to
|
|
|
|
|
|
parse custom grammars when used alongside the <code>synom</code> crate.</p>
|
|
|
|
|
|
|
|
|
|
|
|
<p>Internally, <code>syn</code> uses a fork of <code>nom</code> called <code>synom</code> which resolves a
|
|
|
|
|
|
persistent pitfall of using <code>nom</code> to parse Rust by eliminating the
|
|
|
|
|
|
<code>IResult::Incomplete</code> variant. The <code>synom</code> crate should be used instead
|
|
|
|
|
|
of <code>nom</code> when working with the parsers in this module.</p>
|
|
|
|
|
|
</div><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
|
2017-07-14 23:24:09 +00:00
|
|
|
|
<table>
|
|
|
|
|
|
<tr class=' module-item'>
|
2017-07-14 23:30:16 +00:00
|
|
|
|
<td><a class="enum" href="enum.IResult.html"
|
|
|
|
|
|
title='enum syn::parse::IResult'>IResult</a></td>
|
2017-07-14 23:24:09 +00:00
|
|
|
|
<td class='docblock-short'>
|
2017-07-14 23:30:16 +00:00
|
|
|
|
<p>The result of a parser.</p>
|
2017-07-14 23:24:09 +00:00
|
|
|
|
</td>
|
2017-07-14 23:30:16 +00:00
|
|
|
|
</tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
|
|
|
|
|
|
<table>
|
2017-07-14 23:24:09 +00:00
|
|
|
|
<tr class=' module-item'>
|
2017-07-14 23:30:16 +00:00
|
|
|
|
<td><a class="fn" href="fn.boolean.html"
|
|
|
|
|
|
title='fn syn::parse::boolean'>boolean</a></td>
|
2017-07-14 23:24:09 +00:00
|
|
|
|
<td class='docblock-short'>
|
2017-07-14 23:30:16 +00:00
|
|
|
|
|
2017-07-14 23:24:09 +00:00
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr class=' module-item'>
|
2017-07-14 23:30:16 +00:00
|
|
|
|
<td><a class="fn" href="fn.byte.html"
|
|
|
|
|
|
title='fn syn::parse::byte'>byte</a></td>
|
2017-07-14 23:24:09 +00:00
|
|
|
|
<td class='docblock-short'>
|
2017-07-14 23:30:16 +00:00
|
|
|
|
|
2017-07-14 23:24:09 +00:00
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr class=' module-item'>
|
2017-07-14 23:30:16 +00:00
|
|
|
|
<td><a class="fn" href="fn.byte_string.html"
|
|
|
|
|
|
title='fn syn::parse::byte_string'>byte_string</a></td>
|
2017-07-14 23:24:09 +00:00
|
|
|
|
<td class='docblock-short'>
|
2017-07-14 23:30:16 +00:00
|
|
|
|
|
2017-07-14 23:24:09 +00:00
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr class=' module-item'>
|
2017-07-14 23:30:16 +00:00
|
|
|
|
<td><a class="fn" href="fn.character.html"
|
|
|
|
|
|
title='fn syn::parse::character'>character</a></td>
|
2017-07-14 23:24:09 +00:00
|
|
|
|
<td class='docblock-short'>
|
2017-07-14 23:30:16 +00:00
|
|
|
|
|
2017-07-14 23:24:09 +00:00
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr class=' module-item'>
|
2017-07-14 23:30:16 +00:00
|
|
|
|
<td><a class="fn" href="fn.float.html"
|
|
|
|
|
|
title='fn syn::parse::float'>float</a></td>
|
2017-07-14 23:24:09 +00:00
|
|
|
|
<td class='docblock-short'>
|
2017-07-14 23:30:16 +00:00
|
|
|
|
|
2017-07-14 23:24:09 +00:00
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr class=' module-item'>
|
2017-07-14 23:30:16 +00:00
|
|
|
|
<td><a class="fn" href="fn.ident.html"
|
|
|
|
|
|
title='fn syn::parse::ident'>ident</a></td>
|
2017-07-14 23:24:09 +00:00
|
|
|
|
<td class='docblock-short'>
|
2017-07-14 23:30:16 +00:00
|
|
|
|
|
2017-07-14 23:24:09 +00:00
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr class=' module-item'>
|
2017-07-14 23:30:16 +00:00
|
|
|
|
<td><a class="fn" href="fn.int.html"
|
|
|
|
|
|
title='fn syn::parse::int'>int</a></td>
|
2017-07-14 23:24:09 +00:00
|
|
|
|
<td class='docblock-short'>
|
2017-07-14 23:30:16 +00:00
|
|
|
|
|
2017-07-14 23:24:09 +00:00
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr class=' module-item'>
|
2017-07-14 23:30:16 +00:00
|
|
|
|
<td><a class="fn" href="fn.lifetime.html"
|
|
|
|
|
|
title='fn syn::parse::lifetime'>lifetime</a></td>
|
2017-07-14 23:24:09 +00:00
|
|
|
|
<td class='docblock-short'>
|
2017-07-14 23:30:16 +00:00
|
|
|
|
|
2017-07-14 23:24:09 +00:00
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr class=' module-item'>
|
2017-07-14 23:30:16 +00:00
|
|
|
|
<td><a class="fn" href="fn.lit.html"
|
|
|
|
|
|
title='fn syn::parse::lit'>lit</a></td>
|
2017-07-14 23:24:09 +00:00
|
|
|
|
<td class='docblock-short'>
|
2017-07-14 23:30:16 +00:00
|
|
|
|
|
2017-07-14 23:24:09 +00:00
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr class=' module-item'>
|
2017-07-14 23:30:16 +00:00
|
|
|
|
<td><a class="fn" href="fn.path.html"
|
|
|
|
|
|
title='fn syn::parse::path'>path</a></td>
|
2017-07-14 23:24:09 +00:00
|
|
|
|
<td class='docblock-short'>
|
2017-07-14 23:30:16 +00:00
|
|
|
|
|
2017-07-14 23:24:09 +00:00
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr class=' module-item'>
|
2017-07-14 23:30:16 +00:00
|
|
|
|
<td><a class="fn" href="fn.string.html"
|
|
|
|
|
|
title='fn syn::parse::string'>string</a></td>
|
2017-07-14 23:24:09 +00:00
|
|
|
|
<td class='docblock-short'>
|
2017-07-14 23:30:16 +00:00
|
|
|
|
|
2017-07-14 23:24:09 +00:00
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr class=' module-item'>
|
2017-07-14 23:30:16 +00:00
|
|
|
|
<td><a class="fn" href="fn.tt.html"
|
|
|
|
|
|
title='fn syn::parse::tt'>tt</a></td>
|
2017-07-14 23:24:09 +00:00
|
|
|
|
<td class='docblock-short'>
|
2017-07-14 23:30:16 +00:00
|
|
|
|
|
2017-07-14 23:24:09 +00:00
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr class=' module-item'>
|
2017-07-14 23:30:16 +00:00
|
|
|
|
<td><a class="fn" href="fn.ty.html"
|
|
|
|
|
|
title='fn syn::parse::ty'>ty</a></td>
|
2017-07-14 23:24:09 +00:00
|
|
|
|
<td class='docblock-short'>
|
2017-07-14 23:30:16 +00:00
|
|
|
|
|
2017-07-14 23:24:09 +00:00
|
|
|
|
</td>
|
|
|
|
|
|
</tr></table></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>?</dt>
|
|
|
|
|
|
<dd>Show this help dialog</dd>
|
|
|
|
|
|
<dt>S</dt>
|
|
|
|
|
|
<dd>Focus the search field</dd>
|
|
|
|
|
|
<dt>⇤</dt>
|
|
|
|
|
|
<dd>Move up in search results</dd>
|
|
|
|
|
|
<dt>⇥</dt>
|
|
|
|
|
|
<dd>Move down in search results</dd>
|
|
|
|
|
|
<dt>⏎</dt>
|
|
|
|
|
|
<dd>Go to active search result</dd>
|
|
|
|
|
|
<dt>+</dt>
|
|
|
|
|
|
<dd>Collapse/expand 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 = "../../";
|
2017-07-14 23:30:16 +00:00
|
|
|
|
window.currentCrate = "syn";
|
2017-07-14 23:24:09 +00:00
|
|
|
|
</script>
|
|
|
|
|
|
<script src="../../main.js"></script>
|
|
|
|
|
|
<script defer src="../../search-index.js"></script>
|
|
|
|
|
|
</body>
|
|
|
|
|
|
</html>
|
