mentat/mentat_transaction/index.html
2018-08-22 17:04:13 +00:00

201 lines
No EOL
9.5 KiB
HTML
Raw Permalink 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 `mentat_transaction` crate.">
<meta name="keywords" content="rust, rustlang, rust-lang, mentat_transaction">
<title>mentat_transaction - 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="../main.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 mentat_transaction</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="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'mentat_transaction', 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_transaction</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/mentat_transaction/lib.rs.html#11-538' 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 entity_builder::<a class="struct" href="../mentat_transaction/entity_builder/struct.InProgressBuilder.html" title="struct mentat_transaction::entity_builder::InProgressBuilder">InProgressBuilder</a>;</code></td></tr><tr><td><code>pub use entity_builder::<a class="struct" href="../mentat_transaction/entity_builder/struct.TermBuilder.html" title="struct mentat_transaction::entity_builder::TermBuilder">TermBuilder</a>;</code></td></tr><tr><td><code>pub use metadata::<a class="struct" href="../mentat_transaction/metadata/struct.Metadata.html" title="struct mentat_transaction::metadata::Metadata">Metadata</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="entity_builder/index.html"
title='mod mentat_transaction::entity_builder'>entity_builder</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="metadata/index.html"
title='mod mentat_transaction::metadata'>metadata</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="query/index.html"
title='mod mentat_transaction::query'>query</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.InProgress.html"
title='struct mentat_transaction::InProgress'>InProgress</a></td>
<td class='docblock-short'>
<p>Represents an in-progress, not yet committed, set of changes to the store.
Call <code>commit</code> to commit your changes, or <code>rollback</code> to discard them.
A transaction is held open until you do so.
Your changes will be implicitly dropped along with this struct.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.InProgressRead.html"
title='struct mentat_transaction::InProgressRead'>InProgressRead</a></td>
<td class='docblock-short'>
<p>Represents an in-progress set of reads to the store. Just like <code>InProgress</code>,
which is read-write, but only allows for reads.</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.CacheAction.html"
title='enum mentat_transaction::CacheAction'>CacheAction</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.CacheDirection.html"
title='enum mentat_transaction::CacheDirection'>CacheDirection</a></td>
<td class='docblock-short'>
</td>
</tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
<table>
<tr class=' module-item'>
<td><a class="trait" href="trait.Pullable.html"
title='trait mentat_transaction::Pullable'>Pullable</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="trait" href="trait.Queryable.html"
title='trait mentat_transaction::Queryable'>Queryable</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_transaction";
</script>
<script src="../main.js"></script>
<script defer src="../search-index.js"></script>
</body>
</html>