greg/mentat
1
0
Fork 0
Code Issues 294 Pull requests Projects Releases 9 Packages Wiki Activity
mentat/docs/apis/rust/mentat_query_algebrizer/struct.AlgebraicQuery.html

188 lines
17 KiB
HTML
Raw Normal View History

Add docs to documentation site
2018-06-21 14:44:35 +00:00
<!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 `AlgebraicQuery` struct in crate `mentat_query_algebrizer`.">
<meta name="keywords" content="rust, rustlang, rust-lang, AlgebraicQuery">
<title>mentat_query_algebrizer::AlgebraicQuery - 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 AlgebraicQuery</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#fields">Fields</a><div class="sidebar-links"><a href="#structfield.find_spec">find_spec</a><a href="#structfield.with">with</a><a href="#structfield.named_projection">named_projection</a><a href="#structfield.order">order</a><a href="#structfield.limit">limit</a><a href="#structfield.cc">cc</a></div><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.is_known_empty">is_known_empty</a><a href="#method.is_fully_bound">is_fully_bound</a><a href="#method.is_fully_unit_bound">is_fully_unit_bound</a><a href="#method.unbound_variables">unbound_variables</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</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_algebrizer</a></p><script>window.sidebarCurrent = {name: 'AlgebraicQuery', 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_algebrizer</a>::<wbr><a class="struct" href=''>AlgebraicQuery</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_algebrizer/lib.rs.html#130-150' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct AlgebraicQuery {
Remove docs for rust dependencies
2018-06-22 17:25:54 +00:00
pub find_spec: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/rc/struct.Rc.html" title="struct alloc::rc::Rc">Rc</a>&lt;FindSpec&gt;,
pub with: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/btree/set/struct.BTreeSet.html" title="struct alloc::btree::set::BTreeSet">BTreeSet</a>&lt;Variable&gt;,
pub named_projection: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/btree/set/struct.BTreeSet.html" title="struct alloc::btree::set::BTreeSet">BTreeSet</a>&lt;Variable&gt;,
Add docs to documentation site
2018-06-21 14:44:35 +00:00
pub order: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<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="struct" href="../mentat_query_algebrizer/struct.OrderBy.html" title="struct mentat_query_algebrizer::OrderBy">OrderBy</a>&gt;&gt;,
Remove docs for rust dependencies
2018-06-22 17:25:54 +00:00
pub limit: Limit,
Add docs to documentation site
2018-06-21 14:44:35 +00:00
pub cc: <a class="struct" href="../mentat_query_algebrizer/struct.ConjoiningClauses.html" title="struct mentat_query_algebrizer::ConjoiningClauses">ConjoiningClauses</a>,
// some fields omitted
}</pre></div><h2 id='fields' class='fields small-section-header'>
Fields<a href='#fields' class='anchor'></a></h2><span id="structfield.find_spec" class="structfield small-section-header">
<a href="#structfield.find_spec" class="anchor field"></a>
<span id="find_spec.v" class='invisible'>
Remove docs for rust dependencies
2018-06-22 17:25:54 +00:00
<code>find_spec: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/rc/struct.Rc.html" title="struct alloc::rc::Rc">Rc</a>&lt;FindSpec&gt;</code>
Add docs to documentation site
2018-06-21 14:44:35 +00:00
</span></span><span id="structfield.with" class="structfield small-section-header">
<a href="#structfield.with" class="anchor field"></a>
<span id="with.v" class='invisible'>
Remove docs for rust dependencies
2018-06-22 17:25:54 +00:00
<code>with: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/btree/set/struct.BTreeSet.html" title="struct alloc::btree::set::BTreeSet">BTreeSet</a>&lt;Variable&gt;</code>
Add docs to documentation site
2018-06-21 14:44:35 +00:00
</span></span><div class='docblock'><p>The set of variables that the caller wishes to be used for grouping when aggregating.
These are specified in the query input, as <code>:with</code>, and are then chewed up during projection.
If no variables are supplied, then no additional grouping is necessary beyond the
non-aggregated projection list.</p>
</div><span id="structfield.named_projection" class="structfield small-section-header">
<a href="#structfield.named_projection" class="anchor field"></a>
<span id="named_projection.v" class='invisible'>
Remove docs for rust dependencies
2018-06-22 17:25:54 +00:00
<code>named_projection: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/btree/set/struct.BTreeSet.html" title="struct alloc::btree::set::BTreeSet">BTreeSet</a>&lt;Variable&gt;</code>
Add docs to documentation site
2018-06-21 14:44:35 +00:00
</span></span><div class='docblock'><p>Some query features, such as ordering, are implemented by implicit reference to SQL columns.
In order for these references to be 'live', those columns must be projected.
This is the set of variables that must be so projected.
This is not necessarily every variable that will be so required -- some variables
will already be in the projection list.</p>
</div><span id="structfield.order" class="structfield small-section-header">
<a href="#structfield.order" class="anchor field"></a>
<span id="order.v" class='invisible'>
<code>order: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<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="struct" href="../mentat_query_algebrizer/struct.OrderBy.html" title="struct mentat_query_algebrizer::OrderBy">OrderBy</a>&gt;&gt;</code>
</span></span><span id="structfield.limit" class="structfield small-section-header">
<a href="#structfield.limit" class="anchor field"></a>
<span id="limit.v" class='invisible'>
Remove docs for rust dependencies
2018-06-22 17:25:54 +00:00
<code>limit: Limit</code>
Add docs to documentation site
2018-06-21 14:44:35 +00:00
</span></span><span id="structfield.cc" class="structfield small-section-header">
<a href="#structfield.cc" class="anchor field"></a>
<span id="cc.v" class='invisible'>
<code>cc: <a class="struct" href="../mentat_query_algebrizer/struct.ConjoiningClauses.html" title="struct mentat_query_algebrizer::ConjoiningClauses">ConjoiningClauses</a></code>
</span></span>
<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_algebrizer/struct.AlgebraicQuery.html" title="struct mentat_query_algebrizer::AlgebraicQuery">AlgebraicQuery</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_algebrizer/lib.rs.html#152-189' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.is_known_empty' class="method"><span id='is_known_empty.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.is_known_empty' class='fnname'>is_known_empty</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_query_algebrizer/lib.rs.html#154-156' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><h4 id='method.is_fully_bound' class="method"><span id='is_fully_bound.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.is_fully_bound' class='fnname'>is_fully_bound</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_query_algebrizer/lib.rs.html#159-174' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Return true if every variable in the find spec is fully bound to a single value.</p>
</div><h4 id='method.is_fully_unit_bound' class="method"><span id='is_fully_unit_bound.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.is_fully_unit_bound' class='fnname'>is_fully_unit_bound</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_query_algebrizer/lib.rs.html#178-181' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Return true if every variable in the find spec is fully bound to a single value,
and evaluating the query doesn't require running SQL.</p>
Remove docs for rust dependencies
2018-06-22 17:25:54 +00:00
</div><h4 id='method.unbound_variables' class="method"><span id='unbound_variables.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.unbound_variables' class='fnname'>unbound_variables</a>(&amp;self) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/btree/set/struct.BTreeSet.html" title="struct alloc::btree::set::BTreeSet">BTreeSet</a>&lt;Variable&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_query_algebrizer/lib.rs.html#186-188' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Return a set of the input variables mentioned in the <code>:in</code> clause that have not yet been
Add docs to documentation site
2018-06-21 14:44:35 +00:00
bound. We do this by looking at the CC.</p>
</div></div>
<h2 id='implementations' class='small-section-header'>
Trait Implementations<a href='#implementations' class='anchor'></a>
</h2>
<div id='implementations-list'>
<h3 id='impl-Debug' 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/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../mentat_query_algebrizer/struct.AlgebraicQuery.html" title="struct mentat_query_algebrizer::AlgebraicQuery">AlgebraicQuery</a></code><a href='#impl-Debug' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_query_algebrizer/lib.rs.html#129' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, __arg_0: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -&gt; <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_query_algebrizer/lib.rs.html#129' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
</div></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_algebrizer/struct.AlgebraicQuery.html" title="struct mentat_query_algebrizer::AlgebraicQuery">AlgebraicQuery</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_algebrizer/struct.AlgebraicQuery.html" title="struct mentat_query_algebrizer::AlgebraicQuery">AlgebraicQuery</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_algebrizer";
</script>
<script src="../main.js"></script>
<script defer src="../search-index.js"></script>
</body>
</html>
Reference in a new issue Copy permalink