mentat/docs/apis/rust/0.7.0/mentat_query_projector/struct.ConstantProjector.html

142 lines
13 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 `ConstantProjector` struct in crate `mentat_query_projector`.">
<meta name="keywords" content="rust, rustlang, rust-lang, ConstantProjector">
<title>mentat_query_projector::ConstantProjector - 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 ConstantProjector</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.project_without_rows">project_without_rows</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Projector">Projector</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_projector</a></p><script>window.sidebarCurrent = {name: 'ConstantProjector', 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_projector</a>::<wbr><a class="struct" href=''>ConstantProjector</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_projector/projectors/constant.rs.html#33-36' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct ConstantProjector { /* fields omitted */ }</pre></div><div class='docblock'><p>A projector that produces a <code>QueryResult</code> containing fixed data.
Takes a boxed function that should return an empty result set of the desired type.</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_projector/struct.ConstantProjector.html" title="struct mentat_query_projector::ConstantProjector">ConstantProjector</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_projector/projectors/constant.rs.html#38-54' title='goto source code'>[src]</a></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>(<br>&nbsp;&nbsp;&nbsp;&nbsp;spec: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/rc/struct.Rc.html" title="struct alloc::rc::Rc">Rc</a>&lt;<a class="enum" href="../edn/query/enum.FindSpec.html" title="enum edn::query::FindSpec">FindSpec</a>&gt;, <br>&nbsp;&nbsp;&nbsp;&nbsp;results_factory: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;<a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>() -&gt; <a class="enum" href="../mentat_query_projector/enum.QueryResults.html" title="enum mentat_query_projector::QueryResults">QueryResults</a>&gt;<br>) -&gt; <a class="struct" href="../mentat_query_projector/struct.ConstantProjector.html" title="struct mentat_query_projector::ConstantProjector">ConstantProjector</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_query_projector/projectors/constant.rs.html#39-44' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><h4 id='method.project_without_rows' class="method"><span id='project_without_rows.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.project_without_rows' class='fnname'>project_without_rows</a>&lt;'stmt&gt;(&amp;self) -&gt; <a class="type" href="../mentat_query_projector/errors/type.Result.html" title="type mentat_query_projector::errors::Result">Result</a>&lt;<a class="struct" href="../mentat_query_projector/struct.QueryOutput.html" title="struct mentat_query_projector::QueryOutput">QueryOutput</a>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_query_projector/projectors/constant.rs.html#46-53' 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'>
<h3 id='impl-Projector' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../mentat_query_projector/trait.Projector.html" title="trait mentat_query_projector::Projector">Projector</a> for <a class="struct" href="../mentat_query_projector/struct.ConstantProjector.html" title="struct mentat_query_projector::ConstantProjector">ConstantProjector</a></code><a href='#impl-Projector' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_query_projector/projectors/constant.rs.html#58-66' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.project' class="method"><span id='project.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../mentat_query_projector/trait.Projector.html#tymethod.project' class='fnname'>project</a>&lt;'stmt, 's&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;_sqlite: &amp;'s Connection, <br>&nbsp;&nbsp;&nbsp;&nbsp;_rows: Rows&lt;'stmt&gt;<br>) -&gt; <a class="type" href="../mentat_query_projector/errors/type.Result.html" title="type mentat_query_projector::errors::Result">Result</a>&lt;<a class="struct" href="../mentat_query_projector/struct.QueryOutput.html" title="struct mentat_query_projector::QueryOutput">QueryOutput</a>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_query_projector/projectors/constant.rs.html#59-61' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><h4 id='method.columns' class="method"><span id='columns.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../mentat_query_projector/trait.Projector.html#tymethod.columns' class='fnname'>columns</a>&lt;'s&gt;(&amp;'s self) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;<a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a>&lt;Item = &amp;<a class="enum" href="../edn/query/enum.Element.html" title="enum edn::query::Element">Element</a>&gt; + 's&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_query_projector/projectors/constant.rs.html#63-65' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4></div></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_projector/struct.ConstantProjector.html" title="struct mentat_query_projector::ConstantProjector">ConstantProjector</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_projector/struct.ConstantProjector.html" title="struct mentat_query_projector::ConstantProjector">ConstantProjector</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_projector";
</script>
<script src="../main.js"></script>
<script defer src="../search-index.js"></script>
</body>
</html>