mentat/docs/apis/rust/mentat_cli/command_parser/index.html

290 lines
14 KiB
HTML
Raw Normal View History

2018-06-21 14:44:35 +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">
<meta name="description" content="API documentation for the Rust `command_parser` mod in crate `mentat_cli`.">
<meta name="keywords" content="rust, rustlang, rust-lang, command_parser">
<title>mentat_cli::command_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 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">&#9776;</div>
<p class='location'>Module command_parser</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#enums">Enums</a></li><li><a href="#statics">Statics</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'><a href='../index.html'>mentat_cli</a></p><script>window.sidebarCurrent = {name: 'command_parser', ty: 'mod', 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'>Module <a href='../index.html'>mentat_cli</a>::<wbr><a class="mod" href=''>command_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'>&#x2212;</span>]
</a>
2018-06-22 17:25:54 +00:00
</span><a class='srclink' href='../../src/mentat_cli/command_parser.rs.html#11-767' title='goto source code'>[src]</a></span></h1><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
2018-06-21 14:44:35 +00:00
<table>
<tr class=' module-item'>
<td><a class="enum" href="enum.Command.html"
title='enum mentat_cli::command_parser::Command'>Command</a></td>
<td class='docblock-short'>
</td>
</tr></table><h2 id='statics' class='section-header'><a href="#statics">Statics</a></h2>
<table>
<tr class=' module-item'>
<td><a class="static" href="static.COMMAND_CACHE.html"
title='static mentat_cli::command_parser::COMMAND_CACHE'>COMMAND_CACHE</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="static" href="static.COMMAND_CLOSE.html"
title='static mentat_cli::command_parser::COMMAND_CLOSE'>COMMAND_CLOSE</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="static" href="static.COMMAND_EXIT_LONG.html"
title='static mentat_cli::command_parser::COMMAND_EXIT_LONG'>COMMAND_EXIT_LONG</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="static" href="static.COMMAND_EXIT_SHORT.html"
title='static mentat_cli::command_parser::COMMAND_EXIT_SHORT'>COMMAND_EXIT_SHORT</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="static" href="static.COMMAND_HELP.html"
title='static mentat_cli::command_parser::COMMAND_HELP'>COMMAND_HELP</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="static" href="static.COMMAND_IMPORT_LONG.html"
title='static mentat_cli::command_parser::COMMAND_IMPORT_LONG'>COMMAND_IMPORT_LONG</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="static" href="static.COMMAND_IMPORT_SHORT.html"
title='static mentat_cli::command_parser::COMMAND_IMPORT_SHORT'>COMMAND_IMPORT_SHORT</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="static" href="static.COMMAND_OPEN.html"
title='static mentat_cli::command_parser::COMMAND_OPEN'>COMMAND_OPEN</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="static" href="static.COMMAND_OPEN_EMPTY.html"
title='static mentat_cli::command_parser::COMMAND_OPEN_EMPTY'>COMMAND_OPEN_EMPTY</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="static" href="static.COMMAND_OPEN_EMPTY_ENCRYPTED.html"
title='static mentat_cli::command_parser::COMMAND_OPEN_EMPTY_ENCRYPTED'>COMMAND_OPEN_EMPTY_ENCRYPTED</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="static" href="static.COMMAND_OPEN_ENCRYPTED.html"
title='static mentat_cli::command_parser::COMMAND_OPEN_ENCRYPTED'>COMMAND_OPEN_ENCRYPTED</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="static" href="static.COMMAND_QUERY_EXPLAIN_LONG.html"
title='static mentat_cli::command_parser::COMMAND_QUERY_EXPLAIN_LONG'>COMMAND_QUERY_EXPLAIN_LONG</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="static" href="static.COMMAND_QUERY_EXPLAIN_SHORT.html"
title='static mentat_cli::command_parser::COMMAND_QUERY_EXPLAIN_SHORT'>COMMAND_QUERY_EXPLAIN_SHORT</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="static" href="static.COMMAND_QUERY_LONG.html"
title='static mentat_cli::command_parser::COMMAND_QUERY_LONG'>COMMAND_QUERY_LONG</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="static" href="static.COMMAND_QUERY_PREPARED_LONG.html"
title='static mentat_cli::command_parser::COMMAND_QUERY_PREPARED_LONG'>COMMAND_QUERY_PREPARED_LONG</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="static" href="static.COMMAND_QUERY_SHORT.html"
title='static mentat_cli::command_parser::COMMAND_QUERY_SHORT'>COMMAND_QUERY_SHORT</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="static" href="static.COMMAND_SCHEMA.html"
title='static mentat_cli::command_parser::COMMAND_SCHEMA'>COMMAND_SCHEMA</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="static" href="static.COMMAND_SYNC.html"
title='static mentat_cli::command_parser::COMMAND_SYNC'>COMMAND_SYNC</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="static" href="static.COMMAND_TIMER_LONG.html"
title='static mentat_cli::command_parser::COMMAND_TIMER_LONG'>COMMAND_TIMER_LONG</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="static" href="static.COMMAND_TRANSACT_LONG.html"
title='static mentat_cli::command_parser::COMMAND_TRANSACT_LONG'>COMMAND_TRANSACT_LONG</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="static" href="static.COMMAND_TRANSACT_SHORT.html"
title='static mentat_cli::command_parser::COMMAND_TRANSACT_SHORT'>COMMAND_TRANSACT_SHORT</a></td>
<td class='docblock-short'>
</td>
</tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
<table>
<tr class=' module-item'>
<td><a class="fn" href="fn.command.html"
title='fn mentat_cli::command_parser::command'>command</a></td>
<td class='docblock-short'>
</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>&#9166;</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_cli";
</script>
<script src="../../main.js"></script>
<script defer src="../../search-index.js"></script>
</body>
</html>