mentat/docs/apis/rust/mentat_db/tx_observer/struct.InProgressObserverTransactWatcher.html
2018-06-22 18:25:54 +01:00

149 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 `InProgressObserverTransactWatcher` struct in crate `mentat_db`.">
<meta name="keywords" content="rust, rustlang, rust-lang, InProgressObserverTransactWatcher">
<title>mentat_db::tx_observer::InProgressObserverTransactWatcher - 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 struct">
<!--[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'>Struct InProgressObserverTransactWatcher</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#fields">Fields</a><div class="sidebar-links"><a href="#structfield.txes">txes</a></div><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.new">new</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-TransactWatcher">TransactWatcher</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a></div></div><p class='location'><a href='../index.html'>mentat_db</a>::<wbr><a href='index.html'>tx_observer</a></p><script>window.sidebarCurrent = {name: 'InProgressObserverTransactWatcher', ty: 'struct', 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'>Struct <a href='../index.html'>mentat_db</a>::<wbr><a href='index.html'>tx_observer</a>::<wbr><a class="struct" href=''>InProgressObserverTransactWatcher</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_db/tx_observer.rs.html#162-165' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct InProgressObserverTransactWatcher {
pub txes: <a class="struct" href="https://docs.rs/indexmap/1/indexmap/map/struct.IndexMap.html" title="struct indexmap::map::IndexMap">IndexMap</a>&lt;<a class="type" href="../../mentat_db/types/type.Entid.html" title="type mentat_db::types::Entid">Entid</a>, <a class="type" href="../../mentat_db/types/type.AttributeSet.html" title="type mentat_db::types::AttributeSet">AttributeSet</a>&gt;,
// some fields omitted
}</pre></div><h2 id='fields' class='fields small-section-header'>
Fields<a href='#fields' class='anchor'></a></h2><span id="structfield.txes" class="structfield small-section-header">
<a href="#structfield.txes" class="anchor field"></a>
<span id="txes.v" class='invisible'>
<code>txes: <a class="struct" href="https://docs.rs/indexmap/1/indexmap/map/struct.IndexMap.html" title="struct indexmap::map::IndexMap">IndexMap</a>&lt;<a class="type" href="../../mentat_db/types/type.Entid.html" title="type mentat_db::types::Entid">Entid</a>, <a class="type" href="../../mentat_db/types/type.AttributeSet.html" title="type mentat_db::types::AttributeSet">AttributeSet</a>&gt;</code>
</span></span>
<h2 id='methods' class='small-section-header'>
Methods<a href='#methods' class='anchor'></a>
</h2>
<h3 id='impl' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="struct" href="../../mentat_db/tx_observer/struct.InProgressObserverTransactWatcher.html" title="struct mentat_db::tx_observer::InProgressObserverTransactWatcher">InProgressObserverTransactWatcher</a></code><a href='#impl' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mentat_db/tx_observer.rs.html#167-174' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.new' class='fnname'>new</a>() -&gt; <a class="struct" href="../../mentat_db/tx_observer/struct.InProgressObserverTransactWatcher.html" title="struct mentat_db::tx_observer::InProgressObserverTransactWatcher">InProgressObserverTransactWatcher</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mentat_db/tx_observer.rs.html#168-173' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4></div>
<h2 id='implementations' class='small-section-header'>
Trait Implementations<a href='#implementations' class='anchor'></a>
</h2>
<div id='implementations-list'>
<h3 id='impl-TransactWatcher' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../../mentat_db/trait.TransactWatcher.html" title="trait mentat_db::TransactWatcher">TransactWatcher</a> for <a class="struct" href="../../mentat_db/tx_observer/struct.InProgressObserverTransactWatcher.html" title="struct mentat_db::tx_observer::InProgressObserverTransactWatcher">InProgressObserverTransactWatcher</a></code><a href='#impl-TransactWatcher' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mentat_db/tx_observer.rs.html#176-186' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.datom' class="method"><span id='datom.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../mentat_db/trait.TransactWatcher.html#tymethod.datom' class='fnname'>datom</a>(&amp;mut self, _op: <a class="enum" href="../../edn/entities/enum.OpType.html" title="enum edn::entities::OpType">OpType</a>, _e: <a class="type" href="../../mentat_db/types/type.Entid.html" title="type mentat_db::types::Entid">Entid</a>, a: <a class="type" href="../../mentat_db/types/type.Entid.html" title="type mentat_db::types::Entid">Entid</a>, _v: &amp;<a class="enum" href="../../mentat_db/types/enum.TypedValue.html" title="enum mentat_db::types::TypedValue">TypedValue</a>)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mentat_db/tx_observer.rs.html#177-179' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><h4 id='method.done' class="method"><span id='done.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../mentat_db/trait.TransactWatcher.html#tymethod.done' class='fnname'>done</a>(&amp;mut self, t: &amp;<a class="type" href="../../mentat_db/types/type.Entid.html" title="type mentat_db::types::Entid">Entid</a>, _schema: &amp;<a class="struct" href="../../mentat_db/types/struct.Schema.html" title="struct mentat_db::types::Schema">Schema</a>) -&gt; <a class="type" href="../../mentat_db/errors/type.Result.html" title="type mentat_db::errors::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mentat_db/tx_observer.rs.html#181-185' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Only return an error if you want to interrupt the transact! Called with the schema prior to the transact -- any attributes or attribute changes transacted during this transact are not reflected in the schema. <a href="../../mentat_db/trait.TransactWatcher.html#tymethod.done">Read more</a></p>
</div></div></div>
<h2 id='synthetic-implementations' class='small-section-header'>
Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a>
</h2>
<div id='synthetic-implementations-list'>
<h3 id='impl-Send' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../../mentat_db/tx_observer/struct.InProgressObserverTransactWatcher.html" title="struct mentat_db::tx_observer::InProgressObserverTransactWatcher">InProgressObserverTransactWatcher</a></code><a href='#impl-Send' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../../mentat_db/tx_observer/struct.InProgressObserverTransactWatcher.html" title="struct mentat_db::tx_observer::InProgressObserverTransactWatcher">InProgressObserverTransactWatcher</a></code><a href='#impl-Sync' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div></div></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_db";
</script>
<script src="../../main.js"></script>
<script defer src="../../search-index.js"></script>
</body>
</html>