mentat/mentat_transaction/entity_builder/struct.TermBuilder.html
2018-08-22 17:04:13 +00:00

148 lines
No EOL
17 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 `TermBuilder` struct in crate `mentat_transaction`.">
<meta name="keywords" content="rust, rustlang, rust-lang, TermBuilder">
<title>mentat_transaction::entity_builder::TermBuilder - 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 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 TermBuilder</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.build">build</a><a href="#method.new">new</a><a href="#method.is_empty">is_empty</a><a href="#method.numbered_tempid">numbered_tempid</a><a href="#method.lookup_ref">lookup_ref</a><a href="#method.tx_function">tx_function</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-BuildTerms">BuildTerms</a></div></div><p class='location'><a href='../index.html'>mentat_transaction</a>::<wbr><a href='index.html'>entity_builder</a></p><script>window.sidebarCurrent = {name: 'TermBuilder', 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_transaction</a>::<wbr><a href='index.html'>entity_builder</a>::<wbr><a class="struct" href=''>TermBuilder</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/entity_builder.rs.html#87-90' title='goto source code'>[src]</a></span></h1>
<pre class='rust struct'>pub struct TermBuilder { /* fields omitted */ }</pre>
<h2 id='methods' class='small-section-header'>
Methods<a href='#methods' class='anchor'></a>
</h2>
<h3 id='impl' class='impl'><span class='in-band'><code>impl <a class="struct" href="../../mentat_transaction/entity_builder/struct.TermBuilder.html" title="struct mentat_transaction::entity_builder::TermBuilder">TermBuilder</a></code><a href='#impl' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mentat_transaction/entity_builder.rs.html#145-175' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.build' class="method"><span id='build.v' class='invisible'><code>pub fn <a href='#method.build' class='fnname'>build</a>(self) -&gt; <a class="type" href="../../public_traits/errors/type.Result.html" title="type public_traits::errors::Result">Result</a>&lt;<a class="type" href="../../mentat_transaction/entity_builder/type.Terms.html" title="type mentat_transaction::entity_builder::Terms">Terms</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mentat_transaction/entity_builder.rs.html#146-148' title='goto source code'>[src]</a></span></h4>
<h4 id='method.new' class="method"><span id='new.v' class='invisible'><code>pub fn <a href='#method.new' class='fnname'>new</a>() -&gt; <a class="struct" href="../../mentat_transaction/entity_builder/struct.TermBuilder.html" title="struct mentat_transaction::entity_builder::TermBuilder">TermBuilder</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mentat_transaction/entity_builder.rs.html#150-155' title='goto source code'>[src]</a></span></h4>
<h4 id='method.is_empty' class="method"><span id='is_empty.v' class='invisible'><code>pub fn <a href='#method.is_empty' class='fnname'>is_empty</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mentat_transaction/entity_builder.rs.html#157-159' title='goto source code'>[src]</a></span></h4>
<h4 id='method.numbered_tempid' class="method"><span id='numbered_tempid.v' class='invisible'><code>pub fn <a href='#method.numbered_tempid' class='fnname'>numbered_tempid</a>(&amp;mut self, id: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a>) -&gt; <a class="type" href="../../edn/value_rc/type.ValueRc.html" title="type edn::value_rc::ValueRc">ValueRc</a>&lt;<a class="enum" href="../../edn/entities/enum.TempId.html" title="enum edn::entities::TempId">TempId</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mentat_transaction/entity_builder.rs.html#162-164' title='goto source code'>[src]</a></span></h4>
<h4 id='method.lookup_ref' class="method"><span id='lookup_ref.v' class='invisible'><code>pub fn <a href='#method.lookup_ref' class='fnname'>lookup_ref</a>&lt;A, V&gt;(a: A, v: V) -&gt; <a class="struct" href="../../edn/entities/struct.LookupRef.html" title="struct edn::entities::LookupRef">LookupRef</a>&lt;<a class="enum" href="../../core_traits/enum.TypedValue.html" title="enum core_traits::TypedValue">TypedValue</a>&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;A: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="enum" href="../../edn/entities/enum.AttributePlace.html" title="enum edn::entities::AttributePlace">AttributePlace</a>&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;V: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="enum" href="../../core_traits/enum.TypedValue.html" title="enum core_traits::TypedValue">TypedValue</a>&gt;,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mentat_transaction/entity_builder.rs.html#166-170' title='goto source code'>[src]</a></span></h4>
<h4 id='method.tx_function' class="method"><span id='tx_function.v' class='invisible'><code>pub fn <a href='#method.tx_function' class='fnname'>tx_function</a>(op: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -&gt; <a class="struct" href="../../edn/entities/struct.TxFunction.html" title="struct edn::entities::TxFunction">TxFunction</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mentat_transaction/entity_builder.rs.html#172-174' title='goto source code'>[src]</a></span></h4>
</div>
<h2 id='implementations' class='small-section-header'>
Trait Implementations<a href='#implementations' class='anchor'></a>
</h2>
<h3 id='impl-BuildTerms' class='impl'><span class='in-band'><code>impl <a class="trait" href="../../mentat_transaction/entity_builder/trait.BuildTerms.html" title="trait mentat_transaction::entity_builder::BuildTerms">BuildTerms</a> for <a class="struct" href="../../mentat_transaction/entity_builder/struct.TermBuilder.html" title="struct mentat_transaction::entity_builder::TermBuilder">TermBuilder</a></code><a href='#impl-BuildTerms' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mentat_transaction/entity_builder.rs.html#111-143' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.named_tempid' class="method"><span id='named_tempid.v' class='invisible'><code>fn <a href='../../mentat_transaction/entity_builder/trait.BuildTerms.html#tymethod.named_tempid' class='fnname'>named_tempid</a>&lt;I&gt;(&amp;mut self, name: I) -&gt; <a class="type" href="../../edn/value_rc/type.ValueRc.html" title="type edn::value_rc::ValueRc">ValueRc</a>&lt;<a class="enum" href="../../edn/entities/enum.TempId.html" title="enum edn::entities::TempId">TempId</a>&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>&gt;,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mentat_transaction/entity_builder.rs.html#112-114' title='goto source code'>[src]</a></span></h4>
<h4 id='method.describe_tempid' class="method"><span id='describe_tempid.v' class='invisible'><code>fn <a href='../../mentat_transaction/entity_builder/trait.BuildTerms.html#tymethod.describe_tempid' class='fnname'>describe_tempid</a>(self, name: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -&gt; <a class="struct" href="../../mentat_transaction/entity_builder/struct.EntityBuilder.html" title="struct mentat_transaction::entity_builder::EntityBuilder">EntityBuilder</a>&lt;Self&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mentat_transaction/entity_builder.rs.html#116-119' title='goto source code'>[src]</a></span></h4>
<h4 id='method.describe' class="method"><span id='describe.v' class='invisible'><code>fn <a href='../../mentat_transaction/entity_builder/trait.BuildTerms.html#tymethod.describe' class='fnname'>describe</a>&lt;E&gt;(self, entity: E) -&gt; <a class="struct" href="../../mentat_transaction/entity_builder/struct.EntityBuilder.html" title="struct mentat_transaction::entity_builder::EntityBuilder">EntityBuilder</a>&lt;Self&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;E: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="enum" href="../../edn/entities/enum.EntityPlace.html" title="enum edn::entities::EntityPlace">EntityPlace</a>&lt;<a class="enum" href="../../core_traits/enum.TypedValue.html" title="enum core_traits::TypedValue">TypedValue</a>&gt;&gt;,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mentat_transaction/entity_builder.rs.html#121-126' title='goto source code'>[src]</a></span></h4>
<h4 id='method.add' class="method"><span id='add.v' class='invisible'><code>fn <a href='../../mentat_transaction/entity_builder/trait.BuildTerms.html#tymethod.add' class='fnname'>add</a>&lt;E, A, V&gt;(&amp;mut self, e: E, a: A, v: V) -&gt; <a class="type" href="../../public_traits/errors/type.Result.html" title="type public_traits::errors::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;E: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="enum" href="../../edn/entities/enum.EntityPlace.html" title="enum edn::entities::EntityPlace">EntityPlace</a>&lt;<a class="enum" href="../../core_traits/enum.TypedValue.html" title="enum core_traits::TypedValue">TypedValue</a>&gt;&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;A: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="enum" href="../../edn/entities/enum.AttributePlace.html" title="enum edn::entities::AttributePlace">AttributePlace</a>&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;V: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="enum" href="../../edn/entities/enum.ValuePlace.html" title="enum edn::entities::ValuePlace">ValuePlace</a>&lt;<a class="enum" href="../../core_traits/enum.TypedValue.html" title="enum core_traits::TypedValue">TypedValue</a>&gt;&gt;,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mentat_transaction/entity_builder.rs.html#128-134' title='goto source code'>[src]</a></span></h4>
<h4 id='method.retract' class="method"><span id='retract.v' class='invisible'><code>fn <a href='../../mentat_transaction/entity_builder/trait.BuildTerms.html#tymethod.retract' class='fnname'>retract</a>&lt;E, A, V&gt;(&amp;mut self, e: E, a: A, v: V) -&gt; <a class="type" href="../../public_traits/errors/type.Result.html" title="type public_traits::errors::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;E: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="enum" href="../../edn/entities/enum.EntityPlace.html" title="enum edn::entities::EntityPlace">EntityPlace</a>&lt;<a class="enum" href="../../core_traits/enum.TypedValue.html" title="enum core_traits::TypedValue">TypedValue</a>&gt;&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;A: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="enum" href="../../edn/entities/enum.AttributePlace.html" title="enum edn::entities::AttributePlace">AttributePlace</a>&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;V: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="enum" href="../../edn/entities/enum.ValuePlace.html" title="enum edn::entities::ValuePlace">ValuePlace</a>&lt;<a class="enum" href="../../core_traits/enum.TypedValue.html" title="enum core_traits::TypedValue">TypedValue</a>&gt;&gt;,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/mentat_transaction/entity_builder.rs.html#136-142' title='goto source code'>[src]</a></span></h4>
</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_transaction";
</script>
<script src="../../main.js"></script>
<script defer src="../../search-index.js"></script>
</body>
</html>