336 lines
17 KiB
HTML
336 lines
17 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 `synom` crate.">
|
|||
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, synom">
|
|||
|
|
|
|||
|
|
<title>synom - Rust</title>
|
|||
|
|
|
|||
|
|
<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">
|
|||
|
|
|
|||
|
|
<p class='location'>Crate synom</p><div class="block items"><ul><li><a href="#macros">Macros</a></li><li><a href="#enums">Enums</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'synom', ty: 'mod', relpath: '../'};</script>
|
|||
|
|
</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">
|
|||
|
|
<h1 class='fqn'><span class='in-band'>Crate <a class="mod" href=''>synom</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/synom/lib.rs.html#1-1225' title='goto source code'>[src]</a></span></h1>
|
|||
|
|
<div class='docblock'><p>Adapted from <a href="https://github.com/Geal/nom"><code>nom</code></a> by removing the
|
|||
|
|
<code>IResult::Incomplete</code> variant which:</p>
|
|||
|
|
|
|||
|
|
<ul>
|
|||
|
|
<li>we don't need,</li>
|
|||
|
|
<li>is an unintuitive footgun when working with non-streaming use cases, and</li>
|
|||
|
|
<li>more than doubles compilation time.</li>
|
|||
|
|
</ul>
|
|||
|
|
|
|||
|
|
<h2 id='whitespace-handling-strategy' class='section-header'><a href='#whitespace-handling-strategy'>Whitespace handling strategy</a></h2>
|
|||
|
|
<p>As (sy)nom is a parser combinator library, the parsers provided here and
|
|||
|
|
that you implement yourself are all made up of successively more primitive
|
|||
|
|
parsers, eventually culminating in a small number of fundamental parsers
|
|||
|
|
that are implemented in Rust. Among these are <code>punct!</code> and <code>keyword!</code>.</p>
|
|||
|
|
|
|||
|
|
<p>All synom fundamental parsers (those not combined out of other parsers)
|
|||
|
|
should be written to skip over leading whitespace in their input. This way,
|
|||
|
|
as long as every parser eventually boils down to some combination of
|
|||
|
|
fundamental parsers, we get correct whitespace handling at all levels for
|
|||
|
|
free.</p>
|
|||
|
|
|
|||
|
|
<p>For our use case, this strategy is a huge improvement in usability,
|
|||
|
|
correctness, and compile time over nom's <code>ws!</code> strategy.</p>
|
|||
|
|
</div><h2 id='macros' class='section-header'><a href="#macros">Macros</a></h2>
|
|||
|
|
<table>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="macro" href="macro.alt.html"
|
|||
|
|
title='macro synom::alt'>alt</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Run a series of parsers, returning the result of the first one which
|
|||
|
|
succeeds.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="macro" href="macro.call.html"
|
|||
|
|
title='macro synom::call'>call</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Invoke the given parser function with the passed in arguments.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="macro" href="macro.cond.html"
|
|||
|
|
title='macro synom::cond'>cond</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Conditionally execute the given parser.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="macro" href="macro.cond_reduce.html"
|
|||
|
|
title='macro synom::cond_reduce'>cond_reduce</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Fail to parse if condition is false, otherwise parse the given parser.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="macro" href="macro.delimited.html"
|
|||
|
|
title='macro synom::delimited'>delimited</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Value surrounded by a pair of delimiters.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="macro" href="macro.do_parse.html"
|
|||
|
|
title='macro synom::do_parse'>do_parse</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Run a series of parsers, one after another, optionally assigning the results
|
|||
|
|
a name. Fail if any of the parsers fails.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="macro" href="macro.epsilon.html"
|
|||
|
|
title='macro synom::epsilon'>epsilon</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Parses nothing and always succeeds.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="macro" href="macro.keyword.html"
|
|||
|
|
title='macro synom::keyword'>keyword</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Parse a keyword like "fn" or "struct".</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="macro" href="macro.many0.html"
|
|||
|
|
title='macro synom::many0'>many0</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Parse zero or more values using the given parser.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="macro" href="macro.map.html"
|
|||
|
|
title='macro synom::map'>map</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Transform the result of a parser by applying a function or closure.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="macro" href="macro.named.html"
|
|||
|
|
title='macro synom::named'>named</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Define a function from a parser combination.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="macro" href="macro.not.html"
|
|||
|
|
title='macro synom::not'>not</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Parses successfully if the given parser fails to parse. Does not consume any
|
|||
|
|
of the input.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="macro" href="macro.opt_vec.html"
|
|||
|
|
title='macro synom::opt_vec'>opt_vec</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Turn a failed parse into an empty vector. The argument parser must itself
|
|||
|
|
return a vector.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="macro" href="macro.option.html"
|
|||
|
|
title='macro synom::option'>option</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Turn a failed parse into <code>None</code> and a successful parse into <code>Some</code>.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="macro" href="macro.peek.html"
|
|||
|
|
title='macro synom::peek'>peek</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Parse a value without consuming it from the input data.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="macro" href="macro.preceded.html"
|
|||
|
|
title='macro synom::preceded'>preceded</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Parse two things, returning the value of the second.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="macro" href="macro.punct.html"
|
|||
|
|
title='macro synom::punct'>punct</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Parse a piece of punctuation like "+" or "+=".</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="macro" href="macro.separated_list.html"
|
|||
|
|
title='macro synom::separated_list'>separated_list</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Zero or more values separated by some separator. Does not allow a trailing
|
|||
|
|
seperator.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="macro" href="macro.separated_nonempty_list.html"
|
|||
|
|
title='macro synom::separated_nonempty_list'>separated_nonempty_list</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>One or more values separated by some separator. Does not allow a trailing
|
|||
|
|
separator.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="macro" href="macro.switch.html"
|
|||
|
|
title='macro synom::switch'>switch</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Pattern-match the result of a parser to select which other parser to run.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="macro" href="macro.tag.html"
|
|||
|
|
title='macro synom::tag'>tag</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Parse the given string from exactly the current position in the input. You
|
|||
|
|
almost always want <code>punct!</code> or <code>keyword!</code> instead of this.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="macro" href="macro.take_until.html"
|
|||
|
|
title='macro synom::take_until'>take_until</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Parse the part of the input up to but not including the given string. Fail
|
|||
|
|
to parse if the given string is not present in the input.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="macro" href="macro.terminated.html"
|
|||
|
|
title='macro synom::terminated'>terminated</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Parse two things, returning the value of the first.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="macro" href="macro.terminated_list.html"
|
|||
|
|
title='macro synom::terminated_list'>terminated_list</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Zero or more values separated by some separator. A trailing separator is
|
|||
|
|
allowed.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="macro" href="macro.tuple.html"
|
|||
|
|
title='macro synom::tuple'>tuple</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Run a series of parsers and produce all of the results in a tuple.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="macro" href="macro.value.html"
|
|||
|
|
title='macro synom::value'>value</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Produce the given value without parsing anything. Useful as an argument to
|
|||
|
|
<code>switch!</code>.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
|
|||
|
|
<table>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="enum" href="enum.IResult.html"
|
|||
|
|
title='enum synom::IResult'>IResult</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>The result of a parser.</p>
|
|||
|
|
</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 = "../";
|
|||
|
|
window.currentCrate = "synom";
|
|||
|
|
</script>
|
|||
|
|
<script src="../main.js"></script>
|
|||
|
|
<script defer src="../search-index.js"></script>
|
|||
|
|
</body>
|
|||
|
|
</html>
|