149 lines
26 KiB
HTML
149 lines
26 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 `BuildTerms` trait in crate `mentat_ffi`.">
|
|||
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, BuildTerms">
|
|||
|
|
|
|||
|
|
<title>mentat_ffi::BuildTerms - 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 trait">
|
|||
|
|
<!--[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'>Trait BuildTerms</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.named_tempid">named_tempid</a><a href="#tymethod.describe_tempid">describe_tempid</a><a href="#tymethod.describe">describe</a><a href="#tymethod.add">add</a><a href="#tymethod.retract">retract</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-BuildTerms">TermBuilder</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='index.html'>mentat_ffi</a></p><script>window.sidebarCurrent = {name: 'BuildTerms', ty: 'trait', 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'>Trait <a href='index.html'>mentat_ffi</a>::<wbr><a class="trait" href=''>BuildTerms</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><a class='srclink' href='../src/mentat/entity_builder.rs.html#104-114' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust trait'>pub trait BuildTerms {
|
|||
|
|
fn <a href='#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>>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#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><Self>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#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><Self><br> <span class="where">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>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.add' class='fnname'>add</a><E, V>(<br> &mut self, <br> e: E, <br> a: <a class="struct" href="../mentat_ffi/struct.KnownEntid.html" title="struct mentat_ffi::KnownEntid">KnownEntid</a>, <br> v: V<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>, <a class="enum" href="../mentat/errors/enum.MentatError.html" title="enum mentat::errors::MentatError">MentatError</a>><br> <span class="where">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>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.retract' class='fnname'>retract</a><E, V>(<br> &mut self, <br> e: E, <br> a: <a class="struct" href="../mentat_ffi/struct.KnownEntid.html" title="struct mentat_ffi::KnownEntid">KnownEntid</a>, <br> v: V<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>, <a class="enum" href="../mentat/errors/enum.MentatError.html" title="enum mentat::errors::MentatError">MentatError</a>><br> <span class="where">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>;
|
|||
|
|
}</pre></div>
|
|||
|
|
<h2 id='required-methods' class='small-section-header'>
|
|||
|
|
Required Methods<a href='#required-methods' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<div class='methods'>
|
|||
|
|
<h3 id='tymethod.named_tempid' class='method'><span id='named_tempid.v' class='invisible'><code>fn <a href='#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></span></h3><h3 id='tymethod.describe_tempid' class='method'><span id='describe_tempid.v' class='invisible'><code>fn <a href='#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><Self></code></span></h3><h3 id='tymethod.describe' class='method'><span id='describe.v' class='invisible'><code>fn <a href='#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><Self> <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></span></h3><h3 id='tymethod.add' class='method'><span id='add.v' class='invisible'><code>fn <a href='#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>, <a class="enum" href="../mentat/errors/enum.MentatError.html" title="enum mentat::errors::MentatError">MentatError</a>> <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></span></h3><h3 id='tymethod.retract' class='method'><span id='retract.v' class='invisible'><code>fn <a href='#tymethod.retract' class='fnname'>retract</a><E
|
|||
|
|
<h2 id='foreign-impls' class='small-section-header'>
|
|||
|
|
Implementations on Foreign Types<a href='#foreign-impls' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<h3 id='impl-BuildTerms' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../mentat_ffi/trait.BuildTerms.html" title="trait mentat_ffi::BuildTerms">BuildTerms</a> for <a class="struct" href="../mentat/entity_builder/struct.TermBuilder.html" title="struct mentat::entity_builder::TermBuilder">TermBuilder</a></code><a href='#impl-BuildTerms' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat/entity_builder.rs.html#116-150' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><span class='docblock autohide'><div class='impl-items'><h4 id='method.named_tempid' class="method"><span id='named_tempid.v-1' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.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></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat/entity_builder.rs.html#117-119' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><h4 id='method.describe_tempid' class="method"><span id='describe_tempid.v-1' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.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/entity_builder/struct.TermBuilder.html" title="struct mentat::entity_builder::TermBuilder">TermBuilder</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat/entity_builder.rs.html#121-124' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><h4 id='method.describe' class="method"><span id='describe.v-1' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.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/entity_builder/struct.TermBuilder.html" title="struct mentat::entity_builder::TermBuilder">TermBuilder</a>> <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></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat/entity_builder.rs.html#126-131' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><h4 id='method.add' class="method"><span id='add.v-1' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.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/ni
|
|||
|
|
<h2 id='implementors' class='small-section-header'>
|
|||
|
|
Implementors<a href='#implementors' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<ul class='item-list' id='implementors-list'>
|
|||
|
|
<li><table class='table-display'><tbody><tr><td><code>impl<'a, 'c> BuildTerms for <a class="struct" href="../mentat_ffi/struct.InProgressBuilder.html" title="struct mentat_ffi::InProgressBuilder">InProgressBuilder</a><'a, 'c></code><td><div class='out-of-band'><a class='srclink' href='../src/mentat/entity_builder.rs.html#228-256' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
|
|||
|
|
</ul><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
|
|||
|
|
src="../implementors/mentat/entity_builder/trait.BuildTerms.js">
|
|||
|
|
</script></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>
|