145 lines
25 KiB
HTML
145 lines
25 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 `Store` struct in crate `mentat_ffi`.">
|
|||
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, Store">
|
|||
|
|
|
|||
|
|
<title>mentat_ffi::Store - 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">☰</div>
|
|||
|
|
|
|||
|
|
<p class='location'>Struct Store</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.open">open</a><a href="#method.open_empty">open_empty</a><a href="#method.transact">transact</a><a href="#method.sqlite_mut">sqlite_mut</a><a href="#method.dismantle">dismantle</a><a href="#method.conn">conn</a><a href="#method.begin_read">begin_read</a><a href="#method.begin_transaction">begin_transaction</a><a href="#method.cache">cache</a><a href="#method.register_observer">register_observer</a><a href="#method.unregister_observer">unregister_observer</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Syncable">Syncable</a><a href="#impl-Pullable">Pullable</a><a href="#impl-Queryable">Queryable</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_ffi</a></p><script>window.sidebarCurrent = {name: 'Store', 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_ffi</a>::<wbr><a class="struct" href=''>Store</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></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct Store { /* fields omitted */ }</pre></div><div class='docblock'><p>A convenience wrapper around a single SQLite connection and a Conn. This is suitable
|
|||
|
|
for applications that don't require complex connection management.</p>
|
|||
|
|
</div>
|
|||
|
|
<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_ffi/struct.Store.html" title="struct mentat_ffi::Store">Store</a></code><a href='#impl' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.open' class="method"><span id='open.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.open' class='fnname'>open</a>(path: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../mentat_ffi/struct.Store.html" title="struct mentat_ffi::Store">Store</a>, Error></code></td><td></td></tr></tbody></table></span></h4><div class='docblock'><p>Open a store at the supplied path, ensuring that it includes the bootstrap schema.</p>
|
|||
|
|
</div><h4 id='method.open_empty' class="method"><span id='open_empty.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.open_empty' class='fnname'>open_empty</a>(path: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../mentat_ffi/struct.Store.html" title="struct mentat_ffi::Store">Store</a>, Error></code></td><td></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns a totally blank store with no bootstrap schema. Use <code>open</code> instead.</p>
|
|||
|
|
</div><h4 id='method.transact' class="method"><span id='transact.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.transact' class='fnname'>transact</a>(&mut self, transaction: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../mentat_ffi/struct.TxReport.html" title="struct mentat_ffi::TxReport">TxReport</a>, Error></code></td><td></td></tr></tbody></table></span></h4></div><h3 id='impl-1' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="struct" href="../mentat_ffi/struct.Store.html" title="struct mentat_ffi::Store">Store</a></code><a href='#impl-1' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.sqlite_mut' class="method"><span id='sqlite_mut.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.sqlite_mut' class='fnname'>sqlite_mut</a>(&mut self) -> &mut Connection</code></td><td></td></tr></tbody></table></span></h4><div class='docblock'><p>Intended for use from tests.</p>
|
|||
|
|
</div></div><h3 id='impl-2' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="struct" href="../mentat_ffi/struct.Store.html" title="struct mentat_ffi::Store">Store</a></code><a href='#impl-2' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.dismantle' class="method"><span id='dismantle.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.dismantle' class='fnname'>dismantle</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>Connection, Conn<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a></code></td><td></td></tr></tbody></table></span></h4><h4 id='method.conn' class="method"><span id='conn.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.conn' class='fnname'>conn</a>(&self) -> &Conn</code></td><td></td></tr></tbody></table></span></h4><h4 id='method.begin_read' class="method"><span id='begin_read.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.begin_read' class='fnname'>begin_read</a>(&'m mut self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><InProgressRead<'m, 'm>, Error></code></td><td></td></tr></tbody></table></span></h4><h4 id='method.begin_transaction' class="method"><span id='begin_transaction.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.begin_transaction' class='fnname'>begin_transaction</a>(&'m mut self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../mentat_ffi/struct.InProgress.html" title="struct mentat_ffi::InProgress">InProgress</a><'m, 'm>, Error></code></td><td></td></tr></tbody></table></span></h4><h4 id='method.cache' class="method"><span id='cache.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.cache' class='fnname'>cache</a>(<br> &mut self, <br> attr: &<a class="struct" href="../edn/symbols/struct.Keyword.html" title="struct edn::symbols::Keyword">Keyword</a>, <br> direction: <a class="enum" href="../mentat_ffi/enum.CacheDirection.html" title="enum mentat_ffi::CacheDirection">CacheDirection</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Error></code></td><td></td></tr></tbody></table></span></h4><h4 id='method.register_observer' class="method"><span id='register_observer.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.register_observer' class='fnname'>register_observer</a>(&mut self, key: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>, observer: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/arc/struct.Arc.html" title="struct alloc::arc::Arc">Arc</a><<a class="struct" href="../mentat_ffi/struct.TxObserver.html" title="struct mentat_ffi::TxObserver">TxObserver</a>>)</code></td><td></td></tr></tbody></table></span></h4><h4 id='method.unregister_observer' class="method"><span id='unregister_observer.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.unregister_observer' class='fnname'>unregister_observer</a>(&mut self, key: &<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>)</code></td><td></td></tr></tbody></table></span><
|
|||
|
|
<h2 id='implementations' class='small-section-header'>
|
|||
|
|
Trait Implementations<a href='#implementations' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<div id='implementations-list'>
|
|||
|
|
<h3 id='impl-Syncable' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../mentat_ffi/trait.Syncable.html" title="trait mentat_ffi::Syncable">Syncable</a> for <a class="struct" href="../mentat_ffi/struct.Store.html" title="struct mentat_ffi::Store">Store</a></code><a href='#impl-Syncable' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.sync' class="method"><span id='sync.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../mentat_ffi/trait.Syncable.html#tymethod.sync' class='fnname'>sync</a>(&mut self, server_uri: &<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>, user_uuid: &<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Error></code></td><td></td></tr></tbody></table></span></h4></div><h3 id='impl-Pullable' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl Pullable for <a class="struct" href="../mentat_ffi/struct.Store.html" title="struct mentat_ffi::Store">Store</a></code><a href='#impl-Pullable' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.pull_attributes_for_entities' class="method"><span id='pull_attributes_for_entities.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.pull_attributes_for_entities' class='fnname'>pull_attributes_for_entities</a><E, A>(<br> &self, <br> entities: E, <br> attributes: A<br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/btree/map/struct.BTreeMap.html" title="struct alloc::btree::map::BTreeMap">BTreeMap</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/arc/struct.Arc.html" title="struct alloc::arc::Arc">Arc</a><<a class="struct" href="../mentat_core/types/struct.StructuredMap.html" title="struct mentat_core::types::StructuredMap">StructuredMap</a>>>, Error> <span class="where fmt-newline">where<br> A: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html" title="trait core::iter::traits::IntoIterator">IntoIterator</a><Item = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a>>,<br> E: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html" title="trait core::iter::traits::IntoIterator">IntoIterator</a><Item = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a>>, </span></code></td><td></td></tr></tbody></table></span></h4><h4 id='method.pull_attributes_for_entity' class="method"><span id='pull_attributes_for_entity.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.pull_attributes_for_entity' class='fnname'>pull_attributes_for_entity</a><A>(<br> &self, <br> entity: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a>, <br> attributes: A<br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Re
|
|||
|
|
<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_ffi/struct.Store.html" title="struct mentat_ffi::Store">Store</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_ffi/struct.Store.html" title="struct mentat_ffi::Store">Store</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>⏎</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_ffi";
|
|||
|
|
</script>
|
|||
|
|
<script src="../main.js"></script>
|
|||
|
|
<script defer src="../search-index.js"></script>
|
|||
|
|
</body>
|
|||
|
|
</html>
|