mentat/docs/apis/rust/0.7.0/edn/index.html
Emily Toop c5180656cc
Mentat documentation website using Jekyll (#754)
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
2018-06-25 11:20:36 +01:00

251 lines
No EOL
13 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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 `edn` crate.">
<meta name="keywords" content="rust, rustlang, rust-lang, edn">
<title>edn - 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'>Crate edn</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><li><a href="#enums">Enums</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'edn', 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=''>edn</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>
</span><a class='srclink' href='../src/edn/lib.rs.html#11-67' 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 value_rc::<a class="trait" href="../edn/value_rc/trait.Cloned.html" title="trait edn::value_rc::Cloned">Cloned</a>;</code></td></tr><tr><td><code>pub use value_rc::<a class="trait" href="../edn/value_rc/trait.FromRc.html" title="trait edn::value_rc::FromRc">FromRc</a>;</code></td></tr><tr><td><code>pub use value_rc::<a class="type" href="../edn/value_rc/type.ValueRc.html" title="type edn::value_rc::ValueRc">ValueRc</a>;</code></td></tr><tr><td><code>pub use parse::<a class="struct" href="../edn/parse/struct.ParseError.html" title="struct edn::parse::ParseError">ParseError</a>;</code></td></tr><tr><td><code>pub use types::<a class="trait" href="../edn/types/trait.FromMicros.html" title="trait edn::types::FromMicros">FromMicros</a>;</code></td></tr><tr><td><code>pub use types::<a class="struct" href="../edn/types/struct.Span.html" title="struct edn::types::Span">Span</a>;</code></td></tr><tr><td><code>pub use types::<a class="enum" href="../edn/types/enum.SpannedValue.html" title="enum edn::types::SpannedValue">SpannedValue</a>;</code></td></tr><tr><td><code>pub use types::<a class="trait" href="../edn/types/trait.ToMicros.html" title="trait edn::types::ToMicros">ToMicros</a>;</code></td></tr><tr><td><code>pub use types::<a class="enum" href="../edn/types/enum.Value.html" title="enum edn::types::Value">Value</a>;</code></td></tr><tr><td><code>pub use types::<a class="struct" href="../edn/types/struct.ValueAndSpan.html" title="struct edn::types::ValueAndSpan">ValueAndSpan</a>;</code></td></tr><tr><td><code>pub use symbols::<a class="struct" href="../edn/symbols/struct.Keyword.html" title="struct edn::symbols::Keyword">Keyword</a>;</code></td></tr><tr><td><code>pub use symbols::<a class="struct" href="../edn/symbols/struct.NamespacedSymbol.html" title="struct edn::symbols::NamespacedSymbol">NamespacedSymbol</a>;</code></td></tr><tr><td><code>pub use symbols::<a class="struct" href="../edn/symbols/struct.PlainSymbol.html" title="struct edn::symbols::PlainSymbol">PlainSymbol</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="entities/index.html"
title='mod edn::entities'>entities</a></td>
<td class='docblock-short'>
<p>This module defines core types that support the transaction processor.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="matcher/index.html"
title='mod edn::matcher'>matcher</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="parse/index.html"
title='mod edn::parse'>parse</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="pretty_print/index.html"
title='mod edn::pretty_print'>pretty_print</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="query/index.html"
title='mod edn::query'>query</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="symbols/index.html"
title='mod edn::symbols'>symbols</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="types/index.html"
title='mod edn::types'>types</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="utils/index.html"
title='mod edn::utils'>utils</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="value_rc/index.html"
title='mod edn::value_rc'>value_rc</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.ns_keyword.html"
title='macro edn::ns_keyword'>ns_keyword</a></td>
<td class='docblock-short'>
</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.BigInt.html"
title='struct edn::BigInt'>BigInt</a></td>
<td class='docblock-short'>
<p>A big signed integer type.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.DateTime.html"
title='struct edn::DateTime'>DateTime</a></td>
<td class='docblock-short'>
<p>ISO 8601 combined date and time with time zone.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.OrderedFloat.html"
title='struct edn::OrderedFloat'>OrderedFloat</a></td>
<td class='docblock-short'>
<p>A wrapper around Floats providing an implementation of Ord and Hash.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.Utc.html"
title='struct edn::Utc'>Utc</a></td>
<td class='docblock-short'>
<p>The UTC time zone. This is the most efficient time zone when you don't need the local time.
It is also used as an offset (which is also a dummy type).</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.Uuid.html"
title='struct edn::Uuid'>Uuid</a></td>
<td class='docblock-short'>
<p>A Universally Unique Identifier (UUID).</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.UuidParseError.html"
title='enum edn::UuidParseError'>UuidParseError</a></td>
<td class='docblock-short'>
<p>Error details for string parsing failures.</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>&#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 = "edn";
</script>
<script src="../main.js"></script>
<script defer src="../search-index.js"></script>
</body>
</html>