c5180656cc
Steps to building docs locally:
1. Install Jekyll
2. cd docs
3. bundle exec jekyll serve --incremental
4. open local docs site at http://127.0.0.1:4000/
* basic Jekyll site
* Add docs to documentation site
* Update javadoc to allow for error free builds
* Remove docs for rust dependencies
* Better display examples, about and contributing documentation for Mentat
* Version docs
245 lines
No EOL
12 KiB
HTML
245 lines
No EOL
12 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 `mentat_parser_utils` crate.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, mentat_parser_utils">
|
||
|
||
<title>mentat_parser_utils - 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 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">
|
||
<div class="sidebar-menu">☰</div>
|
||
|
||
<p class='location'>Crate mentat_parser_utils</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#reexports">Re-exports</a></li><li><a href="#modules">Modules</a></li><li><a href="#macros">Macros</a></li><li><a href="#structs">Structs</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'mentat_parser_utils', ty: 'mod', relpath: '../'};</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'>Crate <a class="mod" href=''>mentat_parser_utils</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/mentat_parser_utils/lib.rs.html#11-72' title='goto source code'>[src]</a></span></h1><h2 id='reexports' class='section-header'><a href="#reexports">Re-exports</a></h2>
|
||
<table><tr><td><code>pub use macros::<a class="struct" href="../mentat_parser_utils/macros/struct.KeywordMapParser.html" title="struct mentat_parser_utils::macros::KeywordMapParser">KeywordMapParser</a>;</code></td></tr><tr><td><code>pub use macros::<a class="type" href="../mentat_parser_utils/macros/type.ResultParser.html" title="type mentat_parser_utils::macros::ResultParser">ResultParser</a>;</code></td></tr><tr><td><code>pub use value_and_span::<a class="struct" href="../mentat_parser_utils/value_and_span/struct.Stream.html" title="struct mentat_parser_utils::value_and_span::Stream">Stream</a>;</code></td></tr></table><h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
|
||
<table>
|
||
<tr class=' module-item'>
|
||
<td><a class="mod" href="log/index.html"
|
||
title='mod mentat_parser_utils::log'>log</a></td>
|
||
<td class='docblock-short'>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="mod" href="macros/index.html"
|
||
title='mod mentat_parser_utils::macros'>macros</a></td>
|
||
<td class='docblock-short'>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="mod" href="value_and_span/index.html"
|
||
title='mod mentat_parser_utils::value_and_span'>value_and_span</a></td>
|
||
<td class='docblock-short'>
|
||
|
||
</td>
|
||
</tr></table><h2 id='macros' class='section-header'><a href="#macros">Macros</a></h2>
|
||
<table>
|
||
<tr class=' module-item'>
|
||
<td><a class="macro" href="macro.assert_edn_parses_to.html"
|
||
title='macro mentat_parser_utils::assert_edn_parses_to'>assert_edn_parses_to</a></td>
|
||
<td class='docblock-short'>
|
||
<p><code>assert_edn_parses_to!</code> simplifies some of the boilerplate around running a parser function
|
||
against string input and expecting a certain result.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="macro" href="macro.assert_parse_failure_contains.html"
|
||
title='macro mentat_parser_utils::assert_parse_failure_contains'>assert_parse_failure_contains</a></td>
|
||
<td class='docblock-short'>
|
||
<p><code>assert_parse_failure_contains!</code> simplifies running a parser function against string input and
|
||
expecting a certain failure. This is working around the complexity of pattern matching parse
|
||
errors that contain spans.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="macro" href="macro.assert_parses_to.html"
|
||
title='macro mentat_parser_utils::assert_parses_to'>assert_parses_to</a></td>
|
||
<td class='docblock-short'>
|
||
<p><code>assert_parses_to!</code> simplifies some of the boilerplate around running a
|
||
parser function against input and expecting a certain result.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="macro" href="macro.def_matches_keyword.html"
|
||
title='macro mentat_parser_utils::def_matches_keyword'>def_matches_keyword</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Generate a <code>satisfy</code> expression that matches a <code>Keyword</code> value with the given name.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="macro" href="macro.def_matches_namespaced_keyword.html"
|
||
title='macro mentat_parser_utils::def_matches_namespaced_keyword'>def_matches_namespaced_keyword</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Generate a <code>satisfy</code> expression that matches a <code>Keyword</code> value with the given
|
||
namespace and name.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="macro" href="macro.def_matches_plain_symbol.html"
|
||
title='macro mentat_parser_utils::def_matches_plain_symbol'>def_matches_plain_symbol</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Generate a <code>satisfy</code> expression that matches a <code>PlainSymbol</code> value with the given name.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="macro" href="macro.def_parser.html"
|
||
title='macro mentat_parser_utils::def_parser'>def_parser</a></td>
|
||
<td class='docblock-short'>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="macro" href="macro.keyword_map_of.html"
|
||
title='macro mentat_parser_utils::keyword_map_of'>keyword_map_of</a></td>
|
||
<td class='docblock-short'>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="macro" href="macro.matches_plain_symbol.html"
|
||
title='macro mentat_parser_utils::matches_plain_symbol'>matches_plain_symbol</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Generate a <code>satisfy_map</code> expression that matches a <code>PlainSymbol</code>
|
||
value with the given name.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="macro" href="macro.satisfy_unwrap.html"
|
||
title='macro mentat_parser_utils::satisfy_unwrap'>satisfy_unwrap</a></td>
|
||
<td class='docblock-short'>
|
||
<p><code>satisfy_unwrap!</code> makes it a little easier to implement a <code>satisfy_map</code>
|
||
body that matches a particular <code>Value</code> enum case, otherwise returning <code>None</code>.</p>
|
||
|
||
</td>
|
||
</tr></table><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
||
<table>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.ValueParseError.html"
|
||
title='struct mentat_parser_utils::ValueParseError'>ValueParseError</a></td>
|
||
<td class='docblock-short'>
|
||
<p>A <code>ValueParseError</code> is a <code>combine::primitives::ParseError</code>-alike that implements the <code>Debug</code>,
|
||
<code>Display</code>, and <code>std::error::Error</code> traits. In addition, it doesn't capture references.</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><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 = "mentat_parser_utils";
|
||
</script>
|
||
<script src="../main.js"></script>
|
||
<script defer src="../search-index.js"></script>
|
||
</body>
|
||
</html> |