145 lines
21 KiB
HTML
145 lines
21 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 `InProgressBuilder` struct in crate `mentat_ffi`.">
|
|||
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, InProgressBuilder">
|
|||
|
|
|
|||
|
|
<title>mentat_ffi::InProgressBuilder - 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 InProgressBuilder</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.new">new</a><a href="#method.transact">transact</a><a href="#method.commit">commit</a><a href="#method.add_kw">add_kw</a><a href="#method.retract_kw">retract_kw</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-BuildTerms">BuildTerms</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: 'InProgressBuilder', 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=''>InProgressBuilder</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 InProgressBuilder<'a, 'c> { /* fields omitted */ }</pre></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, 'c> <a class="struct" href="../mentat_ffi/struct.InProgressBuilder.html" title="struct mentat_ffi::InProgressBuilder">InProgressBuilder</a><'a, 'c></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.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>(in_progress: <a class="struct" href="../mentat_ffi/struct.InProgress.html" title="struct mentat_ffi::InProgress">InProgress</a><'a, 'c>) -> <a class="struct" href="../mentat_ffi/struct.InProgressBuilder.html" title="struct mentat_ffi::InProgressBuilder">InProgressBuilder</a><'a, 'c></code></td><td></td></tr></tbody></table></span></h4><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>(self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="struct" href="../mentat_ffi/struct.InProgress.html" title="struct mentat_ffi::InProgress">InProgress</a><'a, 'c>, <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><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a></code></td><td></td></tr></tbody></table></span></h4><div class='docblock'><p>Build the terms from this builder and transact them against the current
|
|||
|
|
<code>InProgress</code>. This method <em>always</em> returns the <code>InProgress</code> -- failure doesn't
|
|||
|
|
imply an automatic rollback.</p>
|
|||
|
|
</div><h4 id='method.commit' class="method"><span id='commit.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.commit' class='fnname'>commit</a>(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.TxReport.html" title="struct mentat_ffi::TxReport">TxReport</a>, Error></code></td><td></td></tr></tbody></table></span></h4><div class='docblock'><p>Transact the contents of the builder and commit the <code>InProgress</code>. If any
|
|||
|
|
step fails, roll back. Return the <code>TxReport</code>.</p>
|
|||
|
|
</div></div><h3 id='impl-1' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<'a, 'c> <a class="struct" href="../mentat_ffi/struct.InProgressBuilder.html" title="struct mentat_ffi::InProgressBuilder">InProgressBuilder</a><'a, 'c></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.add_kw' class="method"><span id='add_kw.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.add_kw' class='fnname'>add_kw</a><E, V>(&mut self, e: E, a: &<a class="struct" href="../edn/symbols/struct.Keyword.html" title="struct edn::symbols::Keyword">Keyword</a>, v: V) -> <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> <span class="where fmt-newline">where<br> E: <a class="trait" href="../mentat_ffi/trait.IntoThing.html" title="trait mentat_ffi::IntoThing">IntoThing</a><<a class="enum" href="../mentat_core/util/enum.Either.html" title="enum mentat_core::util::Either">Either</a><<a class="struct" href="../mentat_ffi/struct.KnownEntid.html" title="struct mentat_ffi::KnownEntid">KnownEntid</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/rc/struct.Rc.html" title="struct alloc::rc::Rc">Rc</a><<a class="enum" href="../edn/entities/enum.TempId.html" title="enum edn::entities::TempId">TempId</a>>>>,<br> V: <a class="trait" href="../mentat_ffi/trait.IntoThing.html" title="trait mentat_ffi::IntoThing">IntoThing</a><<a class="enum" href="../mentat_core/util/enum.Either.html" title="enum mentat_core::util::Either">Either</a><<a class="enum" href="../mentat_ffi/enum.TypedValue.html" title="enum mentat_ffi::TypedValue">TypedValue</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/rc/struct.Rc.html" title="struct alloc::rc::Rc">Rc</a><<a class="enum" href="../edn/entities/enum.TempId.html" title="enum edn::entities::TempId">TempId</a>>>>, </span></code></td><td></td></tr></tbody></table></span></h4><h4 id='method.retract_kw' class="method"><span id='retract_kw.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.retract_kw' class='fnname'>retract_kw</a><E, V>(&mut self, e: E, a: &<a class="struct" href="../edn/symbols/struct.Keyword.html" title="struct edn::symbols::Keyword">Keyword</a>, v: V) -> <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> <span class="where fmt-newline">where<br> E: <a class="trait" href="../mentat_ffi/trait.IntoThing.html" title="trait mentat_ffi::IntoThing">IntoThing</a><<a class="enum" href="../mentat_core/util/enum.Either.html" title="enum mentat_core::util::Either">Either</a><<a class="struct" href="../mentat_ffi/struct.KnownEntid.html" title="struct mentat_ffi::KnownEntid">KnownEntid</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/rc/struct.Rc.html" title="struct alloc::rc::Rc">Rc</a><<a class="enum" href="../edn/entities/enum.TempId.html" title="enum edn::entities::TempId">TempId</a>>>>,<br> V: <a class="trait" href="../mentat_ffi/trait.IntoThing.html" title="trait mentat_ffi::IntoThing">IntoThing</a><<a class="enum" href="../mentat_core/util/enum.Either.html" title="enum mentat_core::util::Either">Either</a><<a class="enum" href="../mentat_ffi/enum.TypedValue.html" title="enum mentat_ffi::TypedValue">TypedValue</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/rc/struct.Rc.html" title="struct alloc::rc::Rc">Rc</a><<a class="enum" href="../edn/enti
|
|||
|
|
<h2 id='implementations' class='small-section-header'>
|
|||
|
|
Trait Implementations<a href='#implementations' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<div id='implementations-list'>
|
|||
|
|
<h3 id='impl-BuildTerms' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<'a, 'c> <a class="trait" href="../mentat_ffi/trait.BuildTerms.html" title="trait mentat_ffi::BuildTerms">BuildTerms</a> for <a class="struct" href="../mentat_ffi/struct.InProgressBuilder.html" title="struct mentat_ffi::InProgressBuilder">InProgressBuilder</a><'a, 'c></code><a href='#impl-BuildTerms' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.named_tempid' class="method"><span id='named_tempid.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../mentat_ffi/trait.BuildTerms.html#tymethod.named_tempid' class='fnname'>named_tempid</a>(&mut self, name: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>) -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/rc/struct.Rc.html" title="struct alloc::rc::Rc">Rc</a><<a class="enum" href="../edn/entities/enum.TempId.html" title="enum edn::entities::TempId">TempId</a>></code></td><td></td></tr></tbody></table></span></h4><h4 id='method.describe_tempid' class="method"><span id='describe_tempid.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../mentat_ffi/trait.BuildTerms.html#tymethod.describe_tempid' class='fnname'>describe_tempid</a>(self, name: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="struct" href="../mentat_ffi/struct.EntityBuilder.html" title="struct mentat_ffi::EntityBuilder">EntityBuilder</a><<a class="struct" href="../mentat_ffi/struct.InProgressBuilder.html" title="struct mentat_ffi::InProgressBuilder">InProgressBuilder</a><'a, 'c>></code></td><td></td></tr></tbody></table></span></h4><h4 id='method.describe' class="method"><span id='describe.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../mentat_ffi/trait.BuildTerms.html#tymethod.describe' class='fnname'>describe</a><E>(self, entity: E) -> <a class="struct" href="../mentat_ffi/struct.EntityBuilder.html" title="struct mentat_ffi::EntityBuilder">EntityBuilder</a><<a class="struct" href="../mentat_ffi/struct.InProgressBuilder.html" title="struct mentat_ffi::InProgressBuilder">InProgressBuilder</a><'a, 'c>> <span class="where fmt-newline">where<br> E: <a class="trait" href="../mentat_ffi/trait.IntoThing.html" title="trait mentat_ffi::IntoThing">IntoThing</a><<a class="enum" href="../mentat_core/util/enum.Either.html" title="enum mentat_core::util::Either">Either</a><<a class="struct" href="../mentat_ffi/struct.KnownEntid.html" title="struct mentat_ffi::KnownEntid">KnownEntid</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/rc/struct.Rc.html" title="struct alloc::rc::Rc">Rc</a><<a class="enum" href="../edn/entities/enum.TempId.html" title="enum edn::entities::TempId">TempId</a>>>>, </span></code></td><td></td></tr></tbody></table></span></h4><h4 id='method.add' class="method"><span id='add.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../mentat_ffi/trait.BuildTerms.html#tymethod.add' class='fnname'>add</a><E, V>(&mut self, e: E, a: <a class="struct" href="../mentat_ffi/struct.KnownEntid.html" title="struct mentat_ffi::KnownEntid">KnownEntid</a>, v: V) -> <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> <span class="where fmt-newline">where<br> E: <a class="trait" href="../mentat_ffi/trait.IntoThing.html" title="trait mentat_ffi::IntoThing">IntoThing</a><<a class="enum" href="../mentat_core/util/enum.Either.html" title="enum mentat_core::util::Either">Either<
|
|||
|
|
<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, 'c> !<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.InProgressBuilder.html" title="struct mentat_ffi::InProgressBuilder">InProgressBuilder</a><'a, 'c></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, 'c> !<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.InProgressBuilder.html" title="struct mentat_ffi::InProgressBuilder">InProgressBuilder</a><'a, 'c></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>
|