mentat/docs/apis/0.7/rust/mentat_query_pull/struct.Puller.html

141 lines
10 KiB
HTML
Raw Normal View History

<!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 `Puller` struct in crate `mentat_query_pull`.">
<meta name="keywords" content="rust, rustlang, rust-lang, Puller">
<title>mentat_query_pull::Puller - 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 Puller</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.prepare">prepare</a><a href="#method.pull">pull</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_query_pull</a></p><script>window.sidebarCurrent = {name: 'Puller', 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_query_pull</a>::<wbr><a class="struct" href=''>Puller</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_query_pull/lib.rs.html#145-157' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct Puller { /* fields omitted */ }</pre></div><div class='docblock'><p>A <code>Puller</code> constructs on demand a map from a provided set of entity IDs to a set of structured maps.</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_query_pull/struct.Puller.html" title="struct mentat_query_pull::Puller">Puller</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_query_pull/lib.rs.html#159-283' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.prepare' class="method"><span id='prepare.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.prepare' class='fnname'>prepare</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;schema: &amp;<a class="struct" href="../mentat_core/struct.Schema.html" title="struct mentat_core::Schema">Schema</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;attributes: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="enum" href="../edn/query/enum.PullAttributeSpec.html" title="enum edn::query::PullAttributeSpec">PullAttributeSpec</a>&gt;<br>) -&gt; <a class="type" href="../mentat_query_pull/errors/type.Result.html" title="type mentat_query_pull::errors::Result">Result</a>&lt;<a class="struct" href="../mentat_query_pull/struct.Puller.html" title="struct mentat_query_pull::Puller">Puller</a>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_query_pull/lib.rs.html#160-223' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><h4 id='method.pull' class="method"><span id='pull.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.pull' class='fnname'>pull</a>&lt;E&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;schema: &amp;<a class="struct" href="../mentat_core/struct.Schema.html" title="struct mentat_core::Schema">Schema</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;db: &amp;Connection, <br>&nbsp;&nbsp;&nbsp;&nbsp;entities: E<br>) -&gt; <a class="type" href="../mentat_query_pull/errors/type.Result.html" title="type mentat_query_pull::errors::Result">Result</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/btree/map/struct.BTreeMap.html" title="struct alloc::btree::map::BTreeMap">BTreeMap</a>&lt;<a class="type" href="../mentat_core/types/type.Entid.html" title="type mentat_core::types::Entid">Entid</a>, <a class="type" href="../edn/value_rc/type.ValueRc.html" title="type edn::value_rc::ValueRc">ValueRc</a>&lt;<a class="struct" href="../mentat_core/types/struct.StructuredMap.html" title="struct mentat_core::types::StructuredMap">StructuredMap</a>&gt;&gt;&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;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>&lt;Item = <a class="type" href="../mentat_core/types/type.Entid.html" title="type mentat_core::types::Entid">Entid</a>&gt;,&nbsp;</span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_query_pull/lib.rs.html#225-281' 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'>
</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_query_pull/struct.Puller.html" title="struct mentat_query_pull::Puller">Puller</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_query_pull/struct.Puller.html" title="struct mentat_query_pull::Puller">Puller</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_query_pull";
</script>
<script src="../main.js"></script>
<script defer src="../search-index.js"></script>
</body>
</html>