135 lines
No EOL
8.2 KiB
HTML
135 lines
No EOL
8.2 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 `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="../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">☰</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></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'>−</span>]
|
||
</a>
|
||
</span><a class='srclink' href='../src/mentat_query_pull/lib.rs.html#141-153' title='goto source code'>[src]</a></span></h1>
|
||
<pre class='rust struct'>pub struct Puller { /* fields omitted */ }</pre><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'><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><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_query_pull/lib.rs.html#155-279' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.prepare' class="method"><span id='prepare.v' class='invisible'><code>pub fn <a href='#method.prepare' class='fnname'>prepare</a>(<br> schema: &<a class="struct" href="../mentat_core/struct.Schema.html" title="struct mentat_core::Schema">Schema</a>, <br> attributes: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="enum" href="../edn/query/enum.PullAttributeSpec.html" title="enum edn::query::PullAttributeSpec">PullAttributeSpec</a>><br>) -> <a class="type" href="../query_pull_traits/errors/type.Result.html" title="type query_pull_traits::errors::Result">Result</a><<a class="struct" href="../mentat_query_pull/struct.Puller.html" title="struct mentat_query_pull::Puller">Puller</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_query_pull/lib.rs.html#156-219' title='goto source code'>[src]</a></span></h4>
|
||
<h4 id='method.pull' class="method"><span id='pull.v' class='invisible'><code>pub fn <a href='#method.pull' class='fnname'>pull</a><E>(<br> &self, <br> schema: &<a class="struct" href="../mentat_core/struct.Schema.html" title="struct mentat_core::Schema">Schema</a>, <br> db: &<a class="struct" href="../rusqlite/struct.Connection.html" title="struct rusqlite::Connection">Connection</a>, <br> entities: E<br>) -> <a class="type" href="../query_pull_traits/errors/type.Result.html" title="type query_pull_traits::errors::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="type" href="../core_traits/type.Entid.html" title="type core_traits::Entid">Entid</a>, <a class="type" href="../edn/value_rc/type.ValueRc.html" title="type edn::value_rc::ValueRc">ValueRc</a><<a class="struct" href="../core_traits/struct.StructuredMap.html" title="struct core_traits::StructuredMap">StructuredMap</a>>>> <span class="where fmt-newline">where<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="type" href="../core_traits/type.Entid.html" title="type core_traits::Entid">Entid</a>>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_query_pull/lib.rs.html#221-277' 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>⏎</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> |